From 03cdb09071c5c9ed9dd0f851a0980d360a4492d0 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Mon, 18 Mar 2013 19:24:55 +0000
Subject: Minor documentation improvements.

---
 Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h  | 2 +-
 Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h        | 2 +-
 Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c       | 4 ++--
 Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h       | 6 +++---
 Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c | 2 +-
 5 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'Demos/Device/ClassDriver/RNDISEthernet')

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
index a5b82615f..e3215706a 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
@@ -62,7 +62,7 @@
 		 *  \param[in] MAC1  First MAC address
 		 *  \param[in] MAC2  Second MAC address
 		 *
-		 *  \return True if the addresses match, false otherwise
+		 *  \return True if the addresses match, \c false otherwise
 		 */
 		#define MAC_COMPARE(MAC1, MAC2)          (memcmp(MAC1, MAC2, sizeof(MAC_Address_t)) == 0)
 
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
index 05ba6dea8..10f1c8c36 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
@@ -59,7 +59,7 @@
 		 *  \param[in] IP1  First IP address
 		 *  \param[in] IP2  Second IP address
 		 *
-		 *  \return True if the addresses match, false otherwise
+		 *  \return True if the addresses match, \c false otherwise
 		 */
 		#define IP_COMPARE(IP1, IP2)             (memcmp(IP1, IP2, sizeof(IP_Address_t)) == 0)
 
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
index 44b5d954f..8caccb053 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
@@ -173,7 +173,7 @@ void TCP_Init(void)
  *  \param[in] State    New state of the port, a value from the \ref TCP_PortStates_t enum
  *  \param[in] Handler  Application callback handler for the port
  *
- *  \return Boolean true if the port state was set, false otherwise (no more space in the port state table)
+ *  \return Boolean \c true if the port state was set, \c false otherwise (no more space in the port state table)
  */
 bool TCP_SetPortState(const uint16_t Port,
                       const uint8_t State,
@@ -247,7 +247,7 @@ uint8_t TCP_GetPortState(const uint16_t Port)
  *  \param[in] RemotePort     TCP port of the remote device in the connection, specified in big endian
  *  \param[in] State          TCP connection state, a value from the \ref TCP_ConnectionStates_t enum
  *
- *  \return Boolean true if the connection was updated or created, false otherwise (no more space in the connection state table)
+ *  \return Boolean \c true if the connection was updated or created, \c false otherwise (no more space in the connection state table)
  */
 bool TCP_SetConnectionState(const uint16_t Port,
                             const IP_Address_t* RemoteAddress,
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
index e1a3ff486..f9a754157 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
@@ -91,7 +91,7 @@
 		 *
 		 *  \param[in] Buffer  Application buffer to check
 		 *
-		 *  \return Boolean true if the buffer contains a packet from the host, false otherwise
+		 *  \return Boolean \c true if the buffer contains a packet from the host, \c false otherwise
 		 */
 		#define TCP_APP_HAS_RECEIVED_PACKET(Buffer)  (Buffer->Ready && (Buffer->Direction == TCP_PACKETDIR_IN))
 
@@ -99,7 +99,7 @@
 		 *
 		 *  \param[in] Buffer  Application buffer to check
 		 *
-		 *  \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise
+		 *  \return Boolean \c true if the buffer has been captured by the application for device-to-host transmissions, \c false otherwise
 		 */
 		#define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && (Buffer->Direction == TCP_PACKETDIR_OUT))
 
@@ -107,7 +107,7 @@
 		 *
 		 *  \param[in] Buffer  Application buffer to check
 		 *
-		 *  \return Boolean true if the buffer may be captured by the application for device-to-host transmissions, false otherwise
+		 *  \return Boolean \c true if the buffer may be captured by the application for device-to-host transmissions, \c false otherwise
 		 */
 		#define TCP_APP_CAN_CAPTURE_BUFFER(Buffer)   Buffer->InUse
 
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c
index 9a937efd5..9dfbebff8 100644
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c
@@ -88,7 +88,7 @@ void Webserver_Init(void)
  *  \param[in] RequestHeader  HTTP request made by the host
  *  \param[in] Command        HTTP command to compare the request to
  *
- *  \return Boolean true if the command matches the request, false otherwise
+ *  \return Boolean \c true if the command matches the request, \c false otherwise
  */
 static bool IsHTTPCommand(uint8_t* RequestHeader,
                           char* Command)
-- 
cgit v1.2.3