diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2013-03-18 19:24:55 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2013-03-18 19:24:55 +0000 |
commit | 03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch) | |
tree | 26aca239e281055455d88b9d44a8a1c52b97beb1 /Demos/Device/LowLevel/RNDISEthernet | |
parent | 88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff) | |
download | lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.bz2 lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip |
Minor documentation improvements.
Diffstat (limited to 'Demos/Device/LowLevel/RNDISEthernet')
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h | 2 | ||||
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/IP.h | 2 | ||||
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c | 4 | ||||
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c | 4 | ||||
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h | 6 | ||||
-rw-r--r-- | Demos/Device/LowLevel/RNDISEthernet/Lib/Webserver.c | 2 |
6 files changed, 10 insertions, 10 deletions
diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h index e92e0f194..457ac613a 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h @@ -60,7 +60,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/LowLevel/RNDISEthernet/Lib/IP.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/IP.h index 340574d64..02f4c54fd 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/IP.h +++ b/Demos/Device/LowLevel/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/LowLevel/RNDISEthernet/Lib/RNDIS.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c index 6e80e6a51..465b2c1b0 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c @@ -237,7 +237,7 @@ void ProcessRNDISControlMessage(void) * \param[out] ResponseData Pointer to the start of the query response inside the RNDIS message buffer * \param[out] ResponseSize Pointer to the size in bytes of the response data being sent to the host * - * \return Boolean true if the query was handled, false otherwise + * \return Boolean \c true if the query was handled, \c false otherwise */ static bool ProcessNDISQuery(const uint32_t OId, void* QueryData, uint16_t QuerySize, void* ResponseData, uint16_t* ResponseSize) @@ -367,7 +367,7 @@ static bool ProcessNDISQuery(const uint32_t OId, void* QueryData, uint16_t Query * \param[in] SetData Pointer to the parameter value in the RNDIS message buffer * \param[in] SetSize Size in bytes of the parameter value being sent by the host * - * \return Boolean true if the set was handled, false otherwise + * \return Boolean \c true if the set was handled, \c false otherwise */ static bool ProcessNDISSet(uint32_t OId, void* SetData, uint16_t SetSize) { diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c index bbac6d0e3..ce156e70b 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c @@ -172,7 +172,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, @@ -246,7 +246,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/LowLevel/RNDISEthernet/Lib/TCP.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h index 3dfbb57df..a471c0ef8 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h +++ b/Demos/Device/LowLevel/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)) @@ -108,7 +108,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/LowLevel/RNDISEthernet/Lib/Webserver.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/Webserver.c index 9cc87cc15..a6fe3ba75 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/Webserver.c +++ b/Demos/Device/LowLevel/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) |