ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation improvements.

Browse source
This commit is contained in:
Dean Camera 2013-03-18 19:24:55 +00:00
parent 88bcc6fde5
commit 03cdb09071
65 changed files with 126 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
View file

@ -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)

2
Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
View file

@ -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)

4
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
View file

@ -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,

6
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
View file

@ -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

2
Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c
View file

@ -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)