Document the Bluetooth ACL layer. Remove unneeded parameters from the signalling...

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

diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h
index 0110b5a..f64710d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ *  Host mode driver for the library USB RNDIS Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassRNDIS\r
  *  @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassRNDIS\r
  *  @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver\r
  *\r


@@ -57,9 +66,16 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_RNDIS_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.\r
+               #endif\r
+\r

        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r

-                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                       /** \brief RNDIS Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r

                         *  and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This\r
                         *  stores each RNDIS interface's configuration and state information.\r
                         */\r
                         *  and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This\r
                         *  stores each RNDIS interface's configuration and state information.\r
                         */\r


@@ -245,7 +261,7 @@
                        #define RNDIS_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r
                        #define RNDIS_FOUND_NOTIFICATION_IN       (1 << 2)\r
 \r
                /* Function Prototypes: */\r

-                       #if defined(INCLUDE_FROM_RNDIS_CLASS_HOST_C)\r
+                       #if defined(__INCLUDE_FROM_RNDIS_CLASS_HOST_C)\r

                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, \r
                                                                             void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,\r
                                static uint8_t RNDIS_SendEncapsulatedCommand(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo, \r
                                                                             void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                                static uint8_t RNDIS_GetEncapsulatedResponse(USB_ClassInfo_RNDIS_Host_t* const RNDISInterfaceInfo,\r