Add briefs for the library core structures.

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

diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h
index b69142c..74e22bd 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h
@@ -31,6 +31,8 @@
 /** \file\r
  *  \brief Common definitions and declarations for the library USB RNDIS Class driver.\r
  *\r
 /** \file\r
  *  \brief Common definitions and declarations for the library USB RNDIS Class driver.\r
  *\r

+ *  Common definitions and declarations 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
  *  \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


@@ -110,13 +112,19 @@
                };\r
                \r
        /* Type Defines: */\r
                };\r
                \r
        /* Type Defines: */\r

-               /** Type define for a physical MAC address of a device on a network */\r
+               /** \brief MAC Address Structure.\r
+                *\r
+                *  Type define for a physical MAC address of a device on a network\r
+                */\r

                typedef struct\r
                {\r
                        uint8_t       Octets[6]; /**< Individual bytes of a MAC address */\r
                } MAC_Address_t;\r
 \r
                typedef struct\r
                {\r
                        uint8_t       Octets[6]; /**< Individual bytes of a MAC address */\r
                } MAC_Address_t;\r
 \r

-               /** Type define for an Ethernet frame buffer. */\r
+               /** \brief RNDIS Ethernet Frame Packet Information Structure.\r
+                *\r
+                *  Type define for an Ethernet frame buffer data and information structure.\r
+                */\r

                typedef struct\r
                {\r
                        uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */\r
                typedef struct\r
                {\r
                        uint8_t       FrameData[ETHERNET_FRAME_SIZE_MAX]; /**< Ethernet frame contents */\r


@@ -124,14 +132,20 @@
                        bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */\r
                } Ethernet_Frame_Info_t;\r
 \r
                        bool          FrameInBuffer; /**< Indicates if a frame is currently stored in the buffer */\r
                } Ethernet_Frame_Info_t;\r
 \r

-               /** Type define for a RNDIS message header, sent before RNDIS messages */\r
+               /** \brief RNDIS Common Message Header Structure.\r
+                *\r
+                *  Type define for a RNDIS message header, sent before RNDIS messages.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */\r
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */\r
                } RNDIS_Message_Header_t;\r
 \r
                typedef struct\r
                {\r
                        uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */\r
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */\r
                } RNDIS_Message_Header_t;\r
 \r

-               /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */\r
+               /** \brief RNDIS Message Structure.\r
+                *\r
+                *  Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -147,7 +161,10 @@
                        uint32_t Reserved;\r
                } RNDIS_Packet_Message_t;\r
 \r
                        uint32_t Reserved;\r
                } RNDIS_Packet_Message_t;\r
 \r

-               /** Type define for a RNDIS Initialize command message */\r
+               /** \brief RNDIS Initialization Message Structure.\r
+                *\r
+                *  Type define for a RNDIS Initialize command message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -159,7 +176,10 @@
                        uint32_t MaxTransferSize;\r
                } RNDIS_Initialize_Message_t;\r
                \r
                        uint32_t MaxTransferSize;\r
                } RNDIS_Initialize_Message_t;\r
                \r

-               /** Type define for a RNDIS Initialize complete response message */\r
+               /** \brief RNDIS Initialize Complete Message Structure.\r
+                *\r
+                *  Type define for a RNDIS Initialize Complete response message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -178,7 +198,10 @@
                        uint32_t AFListSize;\r
                } RNDIS_Initialize_Complete_t;\r
                \r
                        uint32_t AFListSize;\r
                } RNDIS_Initialize_Complete_t;\r
                \r

-               /** Type define for a RNDIS Keepalive command message */\r
+               /** \brief RNDIS Keep Alive Message Structure.\r
+                *\r
+                *  Type define for a RNDIS Keep Alive command message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -186,7 +209,10 @@
                        uint32_t RequestId;\r
                } RNDIS_KeepAlive_Message_t;\r
 \r
                        uint32_t RequestId;\r
                } RNDIS_KeepAlive_Message_t;\r
 \r

-               /** Type define for a RNDIS Keepalive complete message */\r
+               /** \brief RNDIS Keep Alive Complete Message Structure.\r
+                *\r
+                *  Type define for a RNDIS Keep Alive Complete response message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -195,7 +221,10 @@
                        uint32_t Status;\r
                } RNDIS_KeepAlive_Complete_t;\r
 \r
                        uint32_t Status;\r
                } RNDIS_KeepAlive_Complete_t;\r
 \r

-               /** Type define for a RNDIS Reset complete message */\r
+               /** \brief RNDIS Reset Complete Message Structure.\r
+                *\r
+                *  Type define for a RNDIS Reset Complete response message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -205,7 +234,10 @@
                        uint32_t AddressingReset;\r
                } RNDIS_Reset_Complete_t;\r
                \r
                        uint32_t AddressingReset;\r
                } RNDIS_Reset_Complete_t;\r
                \r

-               /** Type define for a RNDIS Set command message */\r
+               /** \brief RNDIS OID Property Set Message Structure.\r
+                *\r
+                *  Type define for a RNDIS OID Property Set command message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -218,7 +250,10 @@
                        uint32_t DeviceVcHandle;\r
                } RNDIS_Set_Message_t;\r
 \r
                        uint32_t DeviceVcHandle;\r
                } RNDIS_Set_Message_t;\r
 \r

-               /** Type define for a RNDIS Set complete response message */\r
+               /** \brief RNDIS OID Property Set Complete Message Structure.\r
+                *\r
+                *  Type define for a RNDIS OID Property Set Complete response message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -227,7 +262,10 @@
                        uint32_t Status;\r
                } RNDIS_Set_Complete_t;\r
                \r
                        uint32_t Status;\r
                } RNDIS_Set_Complete_t;\r
                \r

-               /** Type define for a RNDIS Query command message */\r
+               /** \brief RNDIS OID Property Query Message Structure.\r
+                *\r
+                *  Type define for a RNDIS OID Property Query command message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r


@@ -240,7 +278,10 @@
                        uint32_t DeviceVcHandle;\r
                } RNDIS_Query_Message_t;\r
                \r
                        uint32_t DeviceVcHandle;\r
                } RNDIS_Query_Message_t;\r
                \r

-               /** Type define for a RNDIS Query complete response message */\r
+               /** \brief RNDIS OID Property Query Complete Message Structure.\r
+                *\r
+                *  Type define for a RNDIS OID Property Query Complete response message.\r
+                */\r

                typedef struct\r
                {\r
                        uint32_t MessageType;\r
                typedef struct\r
                {\r
                        uint32_t MessageType;\r