Minor documentation cleanups.

8 files changed, 63 insertions, 64 deletions

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h
index fce77969d..6ae9b7be3 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ARP.h
@@ -45,10 +45,10 @@
 		#include "ProtocolDecoders.h"
 		
 	/* Macros: */
-		/** ARP header operation constant, indicating a request from a host for an address translation */
+		/** ARP header operation constant, indicating a request from a host for an address translation. */
 		#define ARP_OPERATION_REQUEST            1
 
-		/** ARP header operation constant, indicating a reply from a host giving an address translation */
+		/** ARP header operation constant, indicating a reply from a host giving an address translation. */
 		#define ARP_OPERATION_REPLY              2
 
 	/* Type Defines: */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h
index cacdd8ffd..2c8c4d884 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/DHCP.h
@@ -45,52 +45,52 @@
 		#include "ProtocolDecoders.h"
 
 	/* Macros: */
-		/** DHCP operation constant, indicating a request from a host to a DHCP server */
+		/** DHCP operation constant, indicating a request from a host to a DHCP server. */
 		#define DHCP_OP_BOOTREQUEST       0x01
 
-		/** DHCP operation constant, indicating a reply from a DHCP server to a host */
+		/** DHCP operation constant, indicating a reply from a DHCP server to a host. */
 		#define DHCP_OP_BOOTREPLY         0x02
 		
-		/** Hardware type constant, indicating Ethernet as a carrier */
+		/** Hardware type constant, indicating Ethernet as a carrier. */
 		#define DHCP_HTYPE_ETHERNET       0x01
 		
-		/** Magic boot protocol "cookie", inserted into all BOOTP packets (BOOTP is the carrier of DHCP) */
+		/** Magic boot protocol "cookie", inserted into all BOOTP packets (BOOTP is the carrier of DHCP). */
 		#define DHCP_MAGIC_COOKIE         0x63825363
 		
-		/** DHCP option list entry header, indicating that a subnet mask will follow */
+		/** DHCP option list entry header, indicating that a subnet mask will follow. */
 		#define DHCP_OPTION_SUBNETMASK    1
 
-		/** DHCP option list entry header, indicating that the DHCP message type constant will follow */
+		/** DHCP option list entry header, indicating that the DHCP message type constant will follow. */
 		#define DHCP_OPTION_MESSAGETYPE   53
 
-		/** DHCP option list entry header, indicating that the IP address of the DHCP server will follow */
+		/** DHCP option list entry header, indicating that the IP address of the DHCP server will follow. */
 		#define DHCP_OPTION_DHCPSERVER    54
 
-		/** DHCP option list entry header, used to pad out option data */
+		/** DHCP option list entry header, used to pad out option data. */
 		#define DHCP_OPTION_PAD           0
 
-		/** DHCP option list entry header, indicating the end of option data */
+		/** DHCP option list entry header, indicating the end of option data. */
 		#define DHCP_OPTION_END           255
 			
-		/** Message type constant, used in the DHCP option data field, requesting that a DHCP server offer an IP address */
+		/** Message type constant, used in the DHCP option data field, requesting that a DHCP server offer an IP address. */
 		#define DHCP_MESSAGETYPE_DISCOVER 1
 
-		/** Message type constant, used in the DHCP option data field, indicating that a DHCP server is offering an IP address */
+		/** Message type constant, used in the DHCP option data field, indicating that a DHCP server is offering an IP address. */
 		#define DHCP_MESSAGETYPE_OFFER    2
 
-		/** Message type constant, used in the DHCP option data field, requesting that a DHCP server lease a given IP address */
+		/** Message type constant, used in the DHCP option data field, requesting that a DHCP server lease a given IP address. */
 		#define DHCP_MESSAGETYPE_REQUEST  3
 
-		/** Message type constant, used in the DHCP option data field, declining an offered DHCP server IP address lease */
+		/** Message type constant, used in the DHCP option data field, declining an offered DHCP server IP address lease. */
 		#define DHCP_MESSAGETYPE_DECLINE  4
 
-		/** Message type constant, used in the DHCP option data field, ACKing a host IP lease request */
+		/** Message type constant, used in the DHCP option data field, ACKing a host IP lease request. */
 		#define DHCP_MESSAGETYPE_ACK      5
 
-		/** Message type constant, used in the DHCP option data field, NACKing a host IP lease request */
+		/** Message type constant, used in the DHCP option data field, NACKing a host IP lease request. */
 		#define DHCP_MESSAGETYPE_NACK     6
 
-		/** Message type constant, used in the DHCP option data field, indicating that a host is releasing a leased IP address */
+		/** Message type constant, used in the DHCP option data field, indicating that a host is releasing a leased IP address. */
 		#define DHCP_MESSAGETYPE_RELEASE  7
 
 	/* Type Defines: */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
index d5e091c13..6e8798302 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
@@ -52,13 +52,13 @@
 		#include "IP.h"
 		
 	/* Macros: */
-		/** Physical MAC address of the USB RNDIS network adapter */
+		/** Physical MAC address of the USB RNDIS network adapter. */
 		#define ADAPTER_MAC_ADDRESS              {0x02, 0x00, 0x02, 0x00, 0x02, 0x00}
 
-		/** Physical MAC address of the virtual server on the network */
+		/** Physical MAC address of the virtual server on the network. */
 		#define SERVER_MAC_ADDRESS               {0x00, 0x01, 0x00, 0x01, 0x00, 0x01}		
 
-		/** Physical MAC address of the network broadcast address */
+		/** Physical MAC address of the network broadcast address. */
 		#define BROADCAST_MAC_ADDRESS            {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}
 	
 		/** Performs a comparison between two MAC addresses, indicating if they are identical.
@@ -70,17 +70,17 @@
 		 */
 		#define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
 		
-		/** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard */
+		/** Minimum size of an Ethernet packet in bytes, to conform to the Ethernet V2 packet standard. */
 		#define ETHERNET_VER2_MINSIZE            0x0600
 
-		/** Return value for all sub protocol handling routines, indicating that no response packet has been generated */
+		/** Return value for all sub protocol handling routines, indicating that no response packet has been generated. */
 		#define NO_RESPONSE                      0		
 
-		/** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled */
+		/** Return value for all sub protocol handling routines, indicating that the packet has not yet been handled. */
 		#define NO_PROCESS                       -1
 
 	/* Type Defines: */
-		/** Type define for an Ethernet frame header */
+		/** Type define for an Ethernet frame header. */
 		typedef struct
 		{
 			MAC_Address_t Destination; /**< Physical MAC address of the packet recipient */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h
index 6117fe13e..d5c93c695 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/EthernetProtocols.h
@@ -72,7 +72,7 @@
 		#define PROTOCOL_SCTP                    132
 
 	/* Type Defines: */		
-		/** Type define for a protocol IP address of a device on a network */
+		/** Type define for a protocol IP address of a device on a network. */
 		typedef struct
 		{
 			uint8_t       Octets[4]; /**< Individual bytes of an IP address */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
index 6c2fbb134..4fe42957c 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/ICMP.h
@@ -45,22 +45,22 @@
 		#include "ProtocolDecoders.h"
 	
 	/* Macros: */
-		/** ICMP message type constant, indicating an ICMP ECHO Reply message */
+		/** ICMP message type constant, indicating an ICMP ECHO Reply message. */
 		#define ICMP_TYPE_ECHOREPLY              0
 
-		/** ICMP message type constant, indicating a packet destination is unreachable */
+		/** ICMP message type constant, indicating a packet destination is unreachable. */
 		#define ICMP_TYPE_DESTINATIONUNREACHABLE 3
 		
-		/** ICMP message type constant, indicating an ICMP Source Quench message */
+		/** ICMP message type constant, indicating an ICMP Source Quench message. */
 		#define ICMP_TYPE_SOURCEQUENCH           4
 
-		/** ICMP message type constant, indicating an ICMP Redirect message */
+		/** ICMP message type constant, indicating an ICMP Redirect message. */
 		#define ICMP_TYPE_REDIRECTMESSAGE        5
 
-		/** ICMP message type constant, indicating an ICMP ECHO Request message */
+		/** ICMP message type constant, indicating an ICMP ECHO Request message. */
 		#define ICMP_TYPE_ECHOREQUEST            8
 
-		/** ICMP message type constant, indicating an ICMP Time Exceeded message */
+		/** ICMP message type constant, indicating an ICMP Time Exceeded message. */
 		#define ICMP_TYPE_TIMEEXCEEDED           11
 	
 	/* Type Defines: */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
index 82f28e80e..ede537ace 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
@@ -45,16 +45,18 @@
 		#include "ProtocolDecoders.h"
 	
 	/* Macros: */
-		/** Protocol IP address of the host (client) machine, once assigned by DHCP */
+		/** Protocol IP address of the host (client) machine, once assigned by DHCP. */
 		#define CLIENT_IP_ADDRESS                { 10,     0,    0,    1}
 
-		/** Protocol IP address of the virtual server machine */
+		/** Protocol IP address of the virtual server machine. */
 		#define SERVER_IP_ADDRESS                { 10,     0,    0,    2}
 
-		/** Protocol IP address of the broadcast address */
+		/** Protocol IP address of the broadcast address. */
 		#define BROADCAST_IP_ADDRESS             {0xFF, 0xFF, 0xFF, 0xFF}
 
-		/** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination is reached */
+		/** Default Time To Live (TTL) value for sent packets, indicating the maximum allowable hops until their destination
+		 *  is reached.
+		 */
 		#define DEFAULT_TTL                      128
 		
 		/** Performs a comparison between two IP addresses, indicating if they are identical.
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
index 4baa0898f..059f76dc5 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
@@ -45,46 +45,46 @@
 		#include "ProtocolDecoders.h"
 		
 	/* Macros: */
-		/** Maximum number of TCP ports which can be open at the one time */
+		/** Maximum number of TCP ports which can be open at the one time. */
 		#define MAX_OPEN_TCP_PORTS              1
 
-		/** Maximum number of TCP connections which can be sustained at the one time */
+		/** Maximum number of TCP connections which can be sustained at the one time. */
 		#define MAX_TCP_CONNECTIONS             3
 
-		/** TCP window size, giving the maximum number of bytes which can be buffered at the one time */
+		/** TCP window size, giving the maximum number of bytes which can be buffered at the one time. */
 		#define TCP_WINDOW_SIZE                 512
 		
-		/** Port number for HTTP transmissions */
+		/** Port number for HTTP transmissions. */
 		#define TCP_PORT_HTTP                   SwapEndian_16(80)
 		
-		/** Data direction indicator for a TCP application buffer, indicating data from host-to-device */
+		/** Data direction indicator for a TCP application buffer, indicating data from host-to-device. */
 		#define TCP_PACKETDIR_IN                false
 
-		/** Data direction indicator for a TCP application buffer, indicating data from device-to-host */
+		/** Data direction indicator for a TCP application buffer, indicating data from device-to-host. */
 		#define TCP_PACKETDIR_OUT               true
 		
-		/** Congestion Window Reduced TCP flag mask */
+		/** Congestion Window Reduced TCP flag mask. */
 		#define TCP_FLAG_CWR                    (1 << 7)
 
-		/** Explicit Congestion Notification TCP flag mask */
+		/** Explicit Congestion Notification TCP flag mask. */
 		#define TCP_FLAG_ECE                    (1 << 6)
 
-		/** Urgent TCP flag mask */
+		/** Urgent TCP flag mask. */
 		#define TCP_FLAG_URG                    (1 << 5)
 
-		/** Data Acknowledge TCP flag mask */
+		/** Data Acknowledge TCP flag mask. */
 		#define TCP_FLAG_ACK                    (1 << 4)
 
-		/** Data Push TCP flag mask */
+		/** Data Push TCP flag mask. */
 		#define TCP_FLAG_PSH                    (1 << 3)
 
-		/** Reset TCP flag mask */
+		/** Reset TCP flag mask. */
 		#define TCP_FLAG_RST                    (1 << 2)
 
-		/** Synchronize TCP flag mask */
+		/** Synchronize TCP flag mask. */
 		#define TCP_FLAG_SYN                    (1 << 1)
 
-		/** Connection Finalize TCP flag mask */
+		/** Connection Finalize TCP flag mask. */
 		#define TCP_FLAG_FIN                    (1 << 0)
 		
 		/** Application macro: Determines if the given application buffer contains a packet received from the host
@@ -147,14 +147,14 @@
 		#define TCP_APP_CLOSECONNECTION(Connection)  MACROS{ Connection->State = TCP_Connection_Closing;  }MACROE
 
 	/* Enums: */
-		/** Enum for possible TCP port states */
+		/** Enum for possible TCP port states. */
 		enum TCP_PortStates_t
 		{
 			TCP_Port_Closed            = 0, /**< TCP port closed, no connections to a host may be made on this port. */
 			TCP_Port_Open              = 1, /**< TCP port open, connections to a host may be made on this port. */
 		};
 	
-		/** Enum for possible TCP connection states */
+		/** Enum for possible TCP connection states. */
 		enum TCP_ConnectionStates_t
 		{
 			TCP_Connection_Listen      = 0, /**< Listening for a connection from a host */
@@ -171,7 +171,7 @@
 		};
 	
 	/* Type Defines: */
-		/** Type define for a TCP connection buffer structure, including size, data and direction */
+		/** Type define for a TCP connection buffer structure, including size, data and direction. */
 		typedef struct
 		{
 			uint16_t               Length; /**< Length of data in the TCP application buffer */
@@ -180,10 +180,10 @@
 			bool                   Ready; /**< If data from host, indicates buffer ready to be read, otherwise indicates
 			                               *   buffer ready to be sent to the host
 			                               */
-			bool                   InUse; /** Indicates if the buffer is locked to to the current direction, and cannot be changed */
+			bool                   InUse; /**< Indicates if the buffer is locked to to the current direction, and cannot be changed */
 		} TCP_ConnectionBuffer_t;
 
-		/** Type define for a TCP connection information structure */
+		/** Type define for a TCP connection information structure. */
 		typedef struct
 		{
 			uint32_t               SequenceNumberIn; /**< Current TCP sequence number for host-to-device */	
@@ -191,7 +191,7 @@
 			TCP_ConnectionBuffer_t Buffer; /**< Connection application data buffer */
 		} TCP_ConnectionInfo_t;
 
-		/** Type define for a complete TCP connection state */
+		/** Type define for a complete TCP connection state. */
 		typedef struct
 		{
 			uint16_t               Port; /**< Connection port number on the device */
@@ -201,7 +201,7 @@
 			uint8_t                State; /**< Current connection state, a value from the TCP_ConnectionStates_t enum */
 		} TCP_ConnectionState_t;
 
-		/** Type define for a TCP port state */
+		/** Type define for a TCP port state. */
 		typedef struct
 		{
 			uint16_t               Port; /**< TCP port number on the device */
@@ -210,7 +210,7 @@
 			                                              TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */
 		} TCP_PortState_t;
 
-		/** Type define for a TCP packet header */
+		/** Type define for a TCP packet header. */
 		typedef struct
 		{
 			uint16_t               SourcePort; /**< Source port of the TCP packet */
@@ -228,9 +228,6 @@
 			uint16_t               UrgentPointer; /**< Urgent data pointer */
 		} TCP_Header_t;
 		
-	/* External Variables: */
-		TCP_PortState_t PortStateTable[MAX_OPEN_TCP_PORTS];
-
 	/* Function Prototypes: */
 		void                  TCP_TCPTask(USB_ClassInfo_RNDIS_Device_t* RNDISInterfaceInfo);
 		void                  TCP_Init(void);
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h
index 73f7664f7..ee9052275 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h
@@ -45,14 +45,14 @@
 		#include "DHCP.h"
 	
 	/* Macros: */
-		/** Source UDP port for a DHCP request */
+		/** Source UDP port for a DHCP request. */
 		#define UDP_PORT_DHCP_REQUEST 67
 
-		/** Destination UDP port for a DHCP reply */
+		/** Destination UDP port for a DHCP reply. */
 		#define UDP_PORT_DHCP_REPLY   68
 
 	/* Type Defines: */
-		/** Type define for a UDP packet header */
+		/** Type define for a UDP packet header. */
 		typedef struct
 		{
 			uint16_t SourcePort; /**< Packet source port */