Minor documentation cleanups.
[pub/USBasp.git] / Demos / Host / LowLevel / RNDISEthernetHost / Lib / RNDISCommands.h
index 62d1c08..a2f15c5 100644 (file)
                #include "RNDISConstants.h"
 
        /* Type Defines: */
-               /** Type define for a RNDIS message header, sent before RNDIS messages */
+               /** Type define for a RNDIS message header, sent before RNDIS messages. */
                typedef struct
                {
                        uint32_t MessageType; /**< RNDIS message type, a REMOTE_NDIS_*_MSG constant */
                        uint32_t MessageLength; /**< Total length of the RNDIS message, in bytes */
                } RNDIS_Message_Header_t;
 
-               /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter */
+               /** Type define for a RNDIS packet message, used to encapsulate Ethernet packets sent to and from the adapter. */
                typedef struct
                {
                        uint32_t MessageType;
@@ -69,7 +69,7 @@
                        uint32_t Reserved;
                } RNDIS_Packet_Message_t;
        
-               /** Type define for a RNDIS Initialize command message */
+               /** Type define for a RNDIS Initialize command message. */
                typedef struct
                {
                        uint32_t MessageType;
@@ -81,7 +81,7 @@
                        uint32_t MaxTransferSize;
                } RNDIS_Initialize_Message_t;
                
-               /** Type define for a RNDIS Initialize complete response message */
+               /** Type define for a RNDIS Initialize complete response message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t AFListSize;
                } RNDIS_Initialize_Complete_t;
                
-               /** Type define for a RNDIS Keepalive command message */
+               /** Type define for a RNDIS Keepalive command message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t RequestId;
                } RNDIS_KeepAlive_Message_t;
 
-               /** Type define for a RNDIS Keepalive complete message */
+               /** Type define for a RNDIS Keepalive complete message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t Status;
                } RNDIS_KeepAlive_Complete_t;
 
-               /** Type define for a RNDIS Reset complete message */
+               /** Type define for a RNDIS Reset complete message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t AddressingReset;
                } RNDIS_Reset_Complete_t;
                
-               /** Type define for a RNDIS Set command message */
+               /** Type define for a RNDIS Set command message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t DeviceVcHandle;
                } RNDIS_Set_Message_t;
 
-               /** Type define for a RNDIS Set complete response message */
+               /** Type define for a RNDIS Set complete response message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t Status;
                } RNDIS_Set_Complete_t;
                
-               /** Type define for a RNDIS Query command message */
+               /** Type define for a RNDIS Query command message. */
                typedef struct
                {
                        uint32_t MessageType;
                        uint32_t DeviceVcHandle;
                } RNDIS_Query_Message_t;
                
-               /** Type define for a RNDIS Query complete response message */
+               /** Type define for a RNDIS Query complete response message. */
                typedef struct
                {
                        uint32_t MessageType;
                } RNDIS_Query_Complete_t;
 
        /* Macros: */
-               /** RNDIS request to issue a host-to-device NDIS command */
+               /** RNDIS request to issue a host-to-device NDIS command. */
                #define REQ_SendEncapsulatedCommand           0x00
 
-               /** RNDIS request to issue a device-to-host NDIS response */
+               /** RNDIS request to issue a device-to-host NDIS response. */
                #define REQ_GetEncapsulatedResponse           0x01
 
-               /** Implemented RNDIS Version Major */
+               /** Implemented RNDIS Version Major. */
                #define REMOTE_NDIS_VERSION_MAJOR             0x01
 
-               /** Implemented RNDIS Version Minor */
+               /** Implemented RNDIS Version Minor. */
                #define REMOTE_NDIS_VERSION_MINOR             0x00
 
-               /** Pipe number for the RNDIS data IN pipe */
+               /** Pipe number for the RNDIS data IN pipe. */
                #define RNDIS_DATAPIPE_IN                     1
 
-               /** Pipe number for the RNDIS data OUT pipe */
+               /** Pipe number for the RNDIS data OUT pipe. */
                #define RNDIS_DATAPIPE_OUT                    2
 
-               /** Pipe number for the RNDIS notification pipe */
+               /** Pipe number for the RNDIS notification pipe. */
                #define RNDIS_NOTIFICATIONPIPE                3
                
-               /** Additional error code for RNDIS functions when a device returns a logical command failure */
+               /** Additional error code for RNDIS functions when a device returns a logical command failure. */
                #define RNDIS_COMMAND_FAILED                  0xC0
 
        /* Function Prototypes: */