Add Doxygen documentation to the completed portions of the PDI programming protocol...

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

diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h
index 8709aa1..987a7e4 100644 (file)
--- a/LUFA/Drivers/USB/Class/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/RNDIS.h
@@ -29,15 +29,20 @@
 */\r
 \r
 /** \ingroup Group_USBClassDrivers\r
 */\r
 \r
 /** \ingroup Group_USBClassDrivers\r

- *  @defgroup Group_USBClassRNDIS RNDIS Device Class Driver - LUFA/Drivers/Class/RNDIS.h\r
+ *  @defgroup Group_USBClassRNDIS RNDIS Class Driver - LUFA/Drivers/Class/RNDIS.h\r

  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Device/RNDIS.c\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Device/RNDIS.c\r

+ *    - LUFA/Drivers/USB/Class/Host/RNDIS.c\r

  *\r
  *  \section Module Description\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the management of USB RNDIS Ethernet\r
- *  interfaces within a USB device.\r
+ *  RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking\r
+ *  Class, for both Device and Host USB modes. User applications can use this class driver instead of implementing the\r
+ *  RNDIS class manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interface with\r
+ *  Hosts using the USB RNDIS Class.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r


@@ -48,10 +53,18 @@
        /* Includes: */\r
                #include "../HighLevel/USBMode.h"\r
 \r
        /* Includes: */\r
                #include "../HighLevel/USBMode.h"\r
 \r

+               #if defined(NO_STREAM_CALLBACKS)\r
+                       #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.\r
+               #endif\r
+\r

                #if defined(USB_CAN_BE_DEVICE)\r
                        #include "Device/RNDIS.h"\r
                #endif\r
                \r
                #if defined(USB_CAN_BE_DEVICE)\r
                        #include "Device/RNDIS.h"\r
                #endif\r
                \r

+               #if defined(USB_CAN_BE_HOST)\r
+                       #include "Host/RNDIS.h"\r
+               #endif\r
+               \r

 #endif\r
 \r
 /** @} */\r
 #endif\r
 \r
 /** @} */\r