aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/Device/ClassDriver
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
commit03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch)
tree26aca239e281055455d88b9d44a8a1c52b97beb1 /Demos/Device/ClassDriver
parent88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff)
downloadlufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.bz2
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip
Minor documentation improvements.
Diffstat (limited to 'Demos/Device/ClassDriver')
-rw-r--r--Demos/Device/ClassDriver/AudioOutput/AudioOutput.c2
-rw-r--r--Demos/Device/ClassDriver/GenericHID/GenericHID.c2
-rw-r--r--Demos/Device/ClassDriver/Joystick/Joystick.c2
-rw-r--r--Demos/Device/ClassDriver/Keyboard/Keyboard.c2
-rw-r--r--Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c2
-rw-r--r--Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c2
-rw-r--r--Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c2
-rw-r--r--Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c14
-rw-r--r--Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c2
-rw-r--r--Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c14
-rw-r--r--Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c2
-rw-r--r--Demos/Device/ClassDriver/Mouse/Mouse.c2
-rw-r--r--Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h2
-rw-r--r--Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h2
-rw-r--r--Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c4
-rw-r--r--Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h6
-rw-r--r--Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c2
-rw-r--r--Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c2
-rw-r--r--Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c14
-rw-r--r--Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c2
20 files changed, 41 insertions, 41 deletions
diff --git a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
index 92d6c5348..22d19a4d5 100644
--- a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
+++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
@@ -227,7 +227,7 @@ void EVENT_USB_Device_ControlRequest(void)
* \param[in,out] Data Pointer to a location where the parameter data is stored for SET operations, or where
* the retrieved data is to be stored for GET operations.
*
- * \return Boolean true if the property get/set was successful, false otherwise
+ * \return Boolean \c true if the property get/set was successful, \c false otherwise
*/
bool CALLBACK_Audio_Device_GetSetEndpointProperty(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,
const uint8_t EndpointProperty,
diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.c b/Demos/Device/ClassDriver/GenericHID/GenericHID.c
index d56b91409..95dd44d16 100644
--- a/Demos/Device/ClassDriver/GenericHID/GenericHID.c
+++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.c
@@ -136,7 +136,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/Joystick/Joystick.c b/Demos/Device/ClassDriver/Joystick/Joystick.c
index e371831d2..c4576ba00 100644
--- a/Demos/Device/ClassDriver/Joystick/Joystick.c
+++ b/Demos/Device/ClassDriver/Joystick/Joystick.c
@@ -138,7 +138,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.c b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
index 222654346..5c7a6f141 100644
--- a/Demos/Device/ClassDriver/Keyboard/Keyboard.c
+++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
@@ -138,7 +138,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
index 4ea830b5e..6b2e9bb40 100644
--- a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
+++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
@@ -166,7 +166,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c
index 223ab51ea..b37104197 100644
--- a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c
+++ b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c
@@ -137,7 +137,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c
index fe470c4de..d3133e6a6 100644
--- a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c
+++ b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c
@@ -501,7 +501,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/ClassDriver/MassStorage/Lib/SCSI.c b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
index b01366d19..2263aab60 100644
--- a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
+++ b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
@@ -86,7 +86,7 @@ static SCSI_Request_Sense_Response_t SenseData =
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -150,7 +150,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -188,7 +188,7 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -210,7 +210,7 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -233,7 +233,7 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -272,7 +272,7 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInte
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
* \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@ -330,7 +330,7 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c
index fe470c4de..d3133e6a6 100644
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c
@@ -501,7 +501,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/ClassDriver/MassStorageKeyboard/Lib/SCSI.c b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
index b01366d19..2263aab60 100644
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
@@ -86,7 +86,7 @@ static SCSI_Request_Sense_Response_t SenseData =
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -150,7 +150,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -188,7 +188,7 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -210,7 +210,7 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -233,7 +233,7 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -272,7 +272,7 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInte
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
* \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@ -330,7 +330,7 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
index f4ece35fb..00761785c 100644
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
@@ -193,7 +193,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git a/Demos/Device/ClassDriver/Mouse/Mouse.c b/Demos/Device/ClassDriver/Mouse/Mouse.c
index bb16565bd..c9caa1cff 100644
--- a/Demos/Device/ClassDriver/Mouse/Mouse.c
+++ b/Demos/Device/ClassDriver/Mouse/Mouse.c
@@ -138,7 +138,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
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)
diff --git a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c
index fe470c4de..d3133e6a6 100644
--- a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c
+++ b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c
@@ -501,7 +501,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/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
index b01366d19..2263aab60 100644
--- a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
+++ b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
@@ -86,7 +86,7 @@ static SCSI_Request_Sense_Response_t SenseData =
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -150,7 +150,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -188,7 +188,7 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -210,7 +210,7 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -233,7 +233,7 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -272,7 +272,7 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInte
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
* \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@ -330,7 +330,7 @@ static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfa
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \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(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
diff --git a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
index 942a3fbb9..54b8534d9 100644
--- a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
+++ b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
@@ -203,7 +203,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent)
*
- * \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ * \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,