Fix corner case in the HID report descriptor Mouse/Joystick tempates at the 8/16...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / RNDIS.h

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h
index 5aebcc6..f53a8e0 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -33,18 +33,18 @@
  *
  *  Device mode driver for the library USB RNDIS Class driver.
  *
- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.
  */
 
 /** \ingroup Group_USBClassRNDIS
- *  @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver
+ *  \defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/RNDIS.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Device Mode USB Class driver framework interface, for the RNDIS USB Class driver.
  *
  *  @{
@@ -57,8 +57,6 @@
                #include "../../USB.h"
                #include "../Common/RNDIS.h"
 
-               #include <string.h>
-
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
@@ -66,7 +64,7 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
-                       #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
                #endif
 
        /* Public Interface - May be used in end-application: */
@@ -75,7 +73,7 @@
                         *
                         *  Class state structure. An instance of this structure should be made for each RNDIS interface
                         *  within the user application, and passed to each of the RNDIS class driver functions as the
-                        *  RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
+                        *  \c RNDISInterfaceInfo parameter. This stores each RNDIS interface's configuration and state information.
                         */
                        typedef struct
                        {
@@ -130,12 +128,12 @@
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
                         *
-                        *  \return Boolean true if the endpoints were successfully configured, false otherwise.
+                        *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
                         */
                        bool RNDIS_Device_ConfigureEndpoints(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Processes incoming control requests from the host, that are directed to the given RNDIS class interface. This should be
-                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
+                        *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing a RNDIS Class configuration and state.
                         */
@@ -151,7 +149,7 @@
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
-               #if defined(__INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
+               #if defined(__INCLUDE_FROM_RNDIS_DEVICE_C)
                        static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)
                                                                            ATTR_NON_NULL_PTR_ARG(1);
                        static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo,