From 03cdb09071c5c9ed9dd0f851a0980d360a4492d0 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 18 Mar 2013 19:24:55 +0000 Subject: Minor documentation improvements. --- Demos/Device/LowLevel/Joystick/Joystick.c | 2 +- Demos/Device/LowLevel/Keyboard/Keyboard.c | 2 +- Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c | 2 +- Demos/Device/LowLevel/MassStorage/Lib/SCSI.c | 14 +++++++------- Demos/Device/LowLevel/MassStorage/MassStorage.c | 2 +- Demos/Device/LowLevel/Mouse/Mouse.c | 2 +- Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h | 2 +- Demos/Device/LowLevel/RNDISEthernet/Lib/IP.h | 2 +- Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c | 4 ++-- Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c | 4 ++-- Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h | 6 +++--- Demos/Device/LowLevel/RNDISEthernet/Lib/Webserver.c | 2 +- 12 files changed, 22 insertions(+), 22 deletions(-) (limited to 'Demos/Device/LowLevel') diff --git a/Demos/Device/LowLevel/Joystick/Joystick.c b/Demos/Device/LowLevel/Joystick/Joystick.c index 4f8ffc400..4e5af8d2c 100644 --- a/Demos/Device/LowLevel/Joystick/Joystick.c +++ b/Demos/Device/LowLevel/Joystick/Joystick.c @@ -134,7 +134,7 @@ void EVENT_USB_Device_ControlRequest(void) * * \param[out] ReportData Pointer to a HID report data structure to be filled * - * \return Boolean true if the new report differs from the last report, false otherwise + * \return Boolean \c true if the new report differs from the last report, \c false otherwise */ bool GetNextReport(USB_JoystickReport_Data_t* const ReportData) { diff --git a/Demos/Device/LowLevel/Keyboard/Keyboard.c b/Demos/Device/LowLevel/Keyboard/Keyboard.c index 6b54279cf..5ffe72f21 100644 --- a/Demos/Device/LowLevel/Keyboard/Keyboard.c +++ b/Demos/Device/LowLevel/Keyboard/Keyboard.c @@ -37,7 +37,7 @@ #include "Keyboard.h" -/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot +/** Indicates what report mode the host has requested, true for normal HID reporting mode, \c false for special boot * protocol reporting mode. */ static bool UsingReportProtocol = true; diff --git a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c index 7d17a4e6b..b524aa84b 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c +++ b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c @@ -497,7 +497,7 @@ void DataflashManager_ResetDataflashProtections(void) /** Performs a simple test on the attached Dataflash IC(s) to ensure that they are working. * - * \return Boolean true if all media chips are working, false otherwise + * \return Boolean \c true if all media chips are working, \c false otherwise */ bool DataflashManager_CheckDataflashOperation(void) { diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c index f9e61a5fa..f874956b6 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c +++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c @@ -84,7 +84,7 @@ static SCSI_Request_Sense_Response_t SenseData = * to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns * a command failure due to a ILLEGAL REQUEST. * - * \return Boolean true if the command completed successfully, false otherwise + * \return Boolean \c true if the command completed successfully, \c false otherwise */ bool SCSI_DecodeSCSICommand(void) { @@ -146,7 +146,7 @@ bool SCSI_DecodeSCSICommand(void) /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features * and capabilities to the host. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Inquiry(void) { @@ -183,7 +183,7 @@ static bool SCSI_Command_Inquiry(void) /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command, * including the error code and additional error information so that the host can determine why a command failed to complete. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Request_Sense(void) { @@ -208,7 +208,7 @@ static bool SCSI_Command_Request_Sense(void) /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity * on the selected Logical Unit (drive), as a number of OS-sized blocks. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Read_Capacity_10(void) { @@ -235,7 +235,7 @@ static bool SCSI_Command_Read_Capacity_10(void) * board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is * supported. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Send_Diagnostic(void) { @@ -273,7 +273,7 @@ static bool SCSI_Command_Send_Diagnostic(void) * * \param[in] IsDataRead Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE) * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead) { @@ -325,7 +325,7 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead) /** Command processing for an issued SCSI MODE SENSE (6) command. This command returns various informational pages about * the SCSI device, as well as the device's Write Protect status. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_ModeSense_6(void) { diff --git a/Demos/Device/LowLevel/MassStorage/MassStorage.c b/Demos/Device/LowLevel/MassStorage/MassStorage.c index 2243b7fe2..7e8bcc4e5 100644 --- a/Demos/Device/LowLevel/MassStorage/MassStorage.c +++ b/Demos/Device/LowLevel/MassStorage/MassStorage.c @@ -222,7 +222,7 @@ void MassStorage_Task(void) /** Function to read in a command block from the host, via the bulk data OUT endpoint. This function reads in the next command block * if one has been issued, and performs validation to ensure that the block command is valid. * - * \return Boolean true if a valid command block has been read in from the endpoint, false otherwise + * \return Boolean \c true if a valid command block has been read in from the endpoint, \c false otherwise */ static bool ReadInCommandBlock(void) { diff --git a/Demos/Device/LowLevel/Mouse/Mouse.c b/Demos/Device/LowLevel/Mouse/Mouse.c index 144cf4ea1..7575a81f5 100644 --- a/Demos/Device/LowLevel/Mouse/Mouse.c +++ b/Demos/Device/LowLevel/Mouse/Mouse.c @@ -36,7 +36,7 @@ #include "Mouse.h" -/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot +/** Indicates what report mode the host has requested, true for normal HID reporting mode, \c false for special boot * protocol reporting mode. */ static bool UsingReportProtocol = true; 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) -- cgit v1.2.3