projects
/
pub
/
USBasp.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
88bcc6f
)
Minor documentation improvements.
author
Dean Camera
<dean@fourwalledcubicle.com>
Mon, 18 Mar 2013 19:24:55 +0000
(19:24 +0000)
committer
Dean Camera
<dean@fourwalledcubicle.com>
Mon, 18 Mar 2013 19:24:55 +0000
(19:24 +0000)
65 files changed:
Bootloaders/MassStorage/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Bootloaders/Printer/BootloaderPrinter.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/GenericHID/GenericHID.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/Joystick/Joystick.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/Keyboard/Keyboard.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/Mouse/Mouse.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/RNDISEthernet/Lib/Ethernet.h
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/RNDISEthernet/Lib/IP.h
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
patch
|
blob
|
blame
|
history
Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/Joystick/Joystick.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/Keyboard/Keyboard.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/MassStorage/MassStorage.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/Mouse/Mouse.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/Ethernet.h
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/IP.h
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h
patch
|
blob
|
blame
|
history
Demos/Device/LowLevel/RNDISEthernet/Lib/Webserver.c
patch
|
blob
|
blame
|
history
Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
patch
|
blob
|
blame
|
history
Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c
patch
|
blob
|
blame
|
history
Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
patch
|
blob
|
blame
|
history
Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
patch
|
blob
|
blame
|
history
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
patch
|
blob
|
blame
|
history
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
patch
|
blob
|
blame
|
history
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
patch
|
blob
|
blame
|
history
Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
patch
|
blob
|
blame
|
history
LUFA/Common/CompilerSpecific.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/Misc/RingBuffer.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Class/Host/AudioClassHost.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Core/UC3/Host_UC3.h
patch
|
blob
|
blame
|
history
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
patch
|
blob
|
blame
|
history
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
patch
|
blob
|
blame
|
history
Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
patch
|
blob
|
blame
|
history
Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
patch
|
blob
|
blame
|
history
Projects/HIDReportViewer/HIDReportViewer.c
patch
|
blob
|
blame
|
history
Projects/Magstripe/Magstripe.c
patch
|
blob
|
blame
|
history
Projects/MediaController/MediaController.c
patch
|
blob
|
blame
|
history
Projects/TempDataLogger/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Projects/TempDataLogger/Lib/SCSI.c
patch
|
blob
|
blame
|
history
Projects/TempDataLogger/TempDataLogger.c
patch
|
blob
|
blame
|
history
Projects/Webserver/Lib/DHCPCommon.c
patch
|
blob
|
blame
|
history
Projects/Webserver/Lib/DHCPServerApp.c
patch
|
blob
|
blame
|
history
Projects/Webserver/Lib/DataflashManager.c
patch
|
blob
|
blame
|
history
Projects/Webserver/Lib/SCSI.c
patch
|
blob
|
blame
|
history
diff --git
a/Bootloaders/MassStorage/Lib/SCSI.c
b/Bootloaders/MassStorage/Lib/SCSI.c
index
0bb1c7a
..
3df8d30
100644
(file)
--- a/
Bootloaders/MassStorage/Lib/SCSI.c
+++ b/
Bootloaders/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
*
*
* \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)
{
*/
bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@
-148,7
+148,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
*
*
* \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)
{
*/
static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@
-186,7
+186,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
*
*
* \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)
{
*/
static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@
-208,7
+208,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
*
*
* \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)
{
*/
static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@
-232,7
+232,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
* \param[in] IsDataRead Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
*
* \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)
*/
static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@
-274,7
+274,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
*
*
* \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)
{
*/
static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
diff --git
a/Bootloaders/Printer/BootloaderPrinter.c
b/Bootloaders/Printer/BootloaderPrinter.c
index
0e1fbba
..
9a6a8c2
100644
(file)
--- a/
Bootloaders/Printer/BootloaderPrinter.c
+++ b/
Bootloaders/Printer/BootloaderPrinter.c
@@
-80,7
+80,7
@@
static bool PageDirty = false;
*
* \param[in] Byte ASCII byte of data to check
*
*
* \param[in] Byte ASCII byte of data to check
*
- * \return Boolean \c true if the input data is ASCII encoded HEX, false otherwise.
+ * \return Boolean \c true if the input data is ASCII encoded HEX,
\c
false otherwise.
*/
static bool IsHex(const char Byte)
{
*/
static bool IsHex(const char Byte)
{
diff --git
a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
index
92d6c53
..
22d19a4
100644
(file)
--- 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.
*
* \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,
*/
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
d56b914
..
95dd44d
100644
(file)
--- 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)
*
* \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,
*/
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
e371831
..
c4576ba
100644
(file)
--- 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)
*
* \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,
*/
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
2226543
..
5c7a6f1
100644
(file)
--- 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)
*
* \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,
*/
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
4ea830b
..
6b2e9bb
100644
(file)
--- 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)
*
* \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,
*/
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
223ab51
..
b371041
100644
(file)
--- 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)
*
* \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,
*/
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
fe470c4
..
d3133e6
100644
(file)
--- 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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.c
index
b01366d
..
2263aab
100644
(file)
--- 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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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)
*
* \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)
*/
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
*
*
* \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)
{
*/
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
fe470c4
..
d3133e6
100644
(file)
--- 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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.c
index
b01366d
..
2263aab
100644
(file)
--- 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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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)
*
* \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)
*/
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
*
*
* \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)
{
*/
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
f4ece35
..
0076178
100644
(file)
--- 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)
*
* \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,
*/
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
bb16565
..
c9caa1c
100644
(file)
--- 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)
*
* \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,
*/
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
a5b8261
..
e321570
100644
(file)
--- 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
*
* \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)
*/
#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
05ba6de
..
10f1c8c
100644
(file)
--- 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
*
* \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)
*/
#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
44b5d95
..
8caccb0
100644
(file)
--- 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
*
* \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,
*/
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
*
* \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,
*/
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
e1a3ff4
..
f9a7541
100644
(file)
--- 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
*
*
* \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))
*/
#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
*
*
* \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))
*/
#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
*
*
* \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
*/
#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
9a937ef
..
9dfbebf
100644
(file)
--- 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
*
* \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)
*/
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
fe470c4
..
d3133e6
100644
(file)
--- 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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.c
index
b01366d
..
2263aab
100644
(file)
--- 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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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)
*
* \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)
*/
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
*
*
* \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)
{
*/
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
942a3fb
..
54b8534
100644
(file)
--- 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)
*
* \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,
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git
a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
index
ac14066
..
bd972e2
100644
(file)
--- a/
Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
+++ b/
Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
@@
-407,7
+407,7
@@
void TMC_Task(void)
*
* \param[out] MessageHeader Pointer to a location where the read header (if any) should be stored
*
*
* \param[out] MessageHeader Pointer to a location where the read header (if any) should be stored
*
- * \return Boolean
true if a header was read,
false otherwise
+ * \return Boolean
\c true if a header was read, \c
false otherwise
*/
bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)
{
*/
bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)
{
diff --git
a/Demos/Device/LowLevel/Joystick/Joystick.c
b/Demos/Device/LowLevel/Joystick/Joystick.c
index
4f8ffc4
..
4e5af8d
100644
(file)
--- 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
*
*
* \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)
{
*/
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
6b54279
..
5ffe72f
100644
(file)
--- a/
Demos/Device/LowLevel/Keyboard/Keyboard.c
+++ b/
Demos/Device/LowLevel/Keyboard/Keyboard.c
@@
-37,7
+37,7
@@
#include "Keyboard.h"
#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;
* 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
7d17a4e
..
b524aa8
100644
(file)
--- 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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c
index
f9e61a5
..
f874956
100644
(file)
--- 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.
*
* 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)
{
*/
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.
*
/** 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)
{
*/
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.
*
/** 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)
{
*/
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.
*
/** 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)
{
*/
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.
*
* 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)
{
*/
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)
*
*
* \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)
{
*/
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.
*
/** 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)
{
*/
static bool SCSI_Command_ModeSense_6(void)
{
diff --git
a/Demos/Device/LowLevel/MassStorage/MassStorage.c
b/Demos/Device/LowLevel/MassStorage/MassStorage.c
index
2243b7f
..
7e8bcc4
100644
(file)
--- 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.
*
/** 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)
{
*/
static bool ReadInCommandBlock(void)
{
diff --git
a/Demos/Device/LowLevel/Mouse/Mouse.c
b/Demos/Device/LowLevel/Mouse/Mouse.c
index
144cf4e
..
7575a81
100644
(file)
--- a/
Demos/Device/LowLevel/Mouse/Mouse.c
+++ b/
Demos/Device/LowLevel/Mouse/Mouse.c
@@
-36,7
+36,7
@@
#include "Mouse.h"
#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;
* 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
e92e0f1
..
457ac61
100644
(file)
--- 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
*
* \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)
*/
#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
340574d
..
02f4c54
100644
(file)
--- 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
*
* \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)
*/
#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
6e80e6a
..
465b2c1
100644
(file)
--- 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
*
* \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)
*/
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
*
* \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)
{
*/
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
bbac6d0
..
ce156e7
100644
(file)
--- 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
*
* \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,
*/
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
*
* \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,
*/
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
3dfbb57
..
a471c0e
100644
(file)
--- 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
*
*
* \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))
*/
#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
*
*
* \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))
*/
#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
*
*
* \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
*/
#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
9cc87cc
..
a6fe3ba
100644
(file)
--- 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
*
* \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)
*/
static bool IsHTTPCommand(uint8_t* RequestHeader,
char* Command)
diff --git
a/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
b/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
index
4c83813
..
ef9280c
100644
(file)
--- a/
Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
+++ b/
Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c
@@
-103,7
+103,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)
*
* \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,
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git
a/Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c
b/Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c
index
312635b
..
e2f49bc
100644
(file)
--- a/
Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c
+++ b/
Demos/Host/ClassDriver/JoystickHostWithParser/JoystickHostWithParser.c
@@
-250,7
+250,7
@@
void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
b/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
index
2917217
..
58c5029
100644
(file)
--- a/
Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
+++ b/
Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
@@
-272,7
+272,7
@@
void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
b/Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
index
b73808b
..
0ecab53
100644
(file)
--- a/
Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
+++ b/
Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
@@
-259,7
+259,7
@@
void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
index
09fe4e9
..
1e461f8
100644
(file)
--- a/
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
+++ b/
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c
@@
-77,7
+77,7
@@
uint8_t GetHIDReportData(void)
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
index
b63c6b9
..
a2b2414
100644
(file)
--- a/
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
+++ b/
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
@@
-77,7
+77,7
@@
uint8_t GetHIDReportData(void)
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
index
a805c82
..
b05be7c
100644
(file)
--- a/
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
+++ b/
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
@@
-77,7
+77,7
@@
uint8_t GetHIDReportData(void)
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
index
96af69c
..
3e46e9f
100644
(file)
--- a/
Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
+++ b/
Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c
@@
-246,7
+246,7
@@
uint8_t SImage_ReadData(void* const Buffer,
/** Function to test if a PIMA event block is waiting to be read in from the attached device.
*
/** Function to test if a PIMA event block is waiting to be read in from the attached device.
*
- * \return True if an event is waiting to be read in from the device, false otherwise
+ * \return True if an event is waiting to be read in from the device,
\c
false otherwise
*/
bool SImage_IsEventReceived(void)
{
*/
bool SImage_IsEventReceived(void)
{
diff --git
a/LUFA/Common/CompilerSpecific.h
b/LUFA/Common/CompilerSpecific.h
index
d3d7caa
..
b2818fa
100644
(file)
--- a/
LUFA/Common/CompilerSpecific.h
+++ b/
LUFA/Common/CompilerSpecific.h
@@
-82,7
+82,7
@@
*
* \param[in] x Value to check compile-time constantness of.
*
*
* \param[in] x Value to check compile-time constantness of.
*
- * \return Boolean
true if the given value is known to be a compile time constant,
false otherwise.
+ * \return Boolean
\c true if the given value is known to be a compile time constant, \c
false otherwise.
*/
#define GCC_IS_COMPILE_CONST(x) __builtin_constant_p(x)
#else
*/
#define GCC_IS_COMPILE_CONST(x) __builtin_constant_p(x)
#else
diff --git
a/LUFA/Drivers/Misc/RingBuffer.h
b/LUFA/Drivers/Misc/RingBuffer.h
index
07ae0cd
..
0ab3e33
100644
(file)
--- a/
LUFA/Drivers/Misc/RingBuffer.h
+++ b/
LUFA/Drivers/Misc/RingBuffer.h
@@
-204,7
+204,7
@@
*
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
*
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
- * \return Boolean \c true if the buffer contains no free space, false otherwise.
+ * \return Boolean \c true if the buffer contains no free space,
\c
false otherwise.
*/
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
*/
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
@@
-218,7
+218,7
@@
*
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
*
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
*
- * \return Boolean \c true if the buffer contains no free space, false otherwise.
+ * \return Boolean \c true if the buffer contains no free space,
\c
false otherwise.
*/
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
*/
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
diff --git
a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
index
474f570
..
1c3b60a
100644
(file)
--- a/
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
+++ b/
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
@@
-369,7
+369,7
@@
/** Indicates if the current ADC conversion is completed, or still in progress.
*
/** Indicates if the current ADC conversion is completed, or still in progress.
*
- * \return Boolean false if the reading is still taking place, or true if the conversion is
+ * \return Boolean
\c
false if the reading is still taking place, or true if the conversion is
* complete and ready to be read out with \ref ADC_GetResult().
*/
static inline bool ADC_IsReadingComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
* complete and ready to be read out with \ref ADC_GetResult().
*/
static inline bool ADC_IsReadingComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE;
diff --git
a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h
b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h
index
b58e5ba
..
a501868
100644
(file)
--- a/
LUFA/Drivers/USB/Class/Host/AudioClassHost.h
+++ b/
LUFA/Drivers/USB/Class/Host/AudioClassHost.h
@@
-131,7
+131,7
@@
* send and/or received.
*
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state.
* send and/or received.
*
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state.
- * \param[in] EnableStreaming Boolean true to enable streaming of the specified interface, false to disable
+ * \param[in] EnableStreaming Boolean true to enable streaming of the specified interface,
\c
false to disable
*
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
*/
*
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
*/
diff --git
a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
index
985bc80
..
7eaabae
100644
(file)
--- a/
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
+++ b/
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
@@
-501,7
+501,7
@@
UECONX |= (1 << STALLRQC);
}
UECONX |= (1 << STALLRQC);
}
- /** Determines if the currently selected endpoint is stalled, false otherwise.
+ /** Determines if the currently selected endpoint is stalled,
\c
false otherwise.
*
* \ingroup Group_EndpointPacketManagement_AVR8
*
*
* \ingroup Group_EndpointPacketManagement_AVR8
*
diff --git
a/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
b/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
index
07f3f3f
..
4f7f024
100644
(file)
--- a/
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
+++ b/
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
@@
-236,7
+236,7
@@
}
/** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
}
/** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
- * that the host resume the USB bus and wake up the device, false otherwise.
+ * that the host resume the USB bus and wake up the device,
\c
false otherwise.
*
* \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
*/
*
* \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
*/
diff --git
a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
index
a812c38
..
bcf6b64
100644
(file)
--- a/
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
+++ b/
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
@@
-501,7
+501,7
@@
(&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].stallrqc = true;
}
(&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].stallrqc = true;
}
- /** Determines if the currently selected endpoint is stalled, false otherwise.
+ /** Determines if the currently selected endpoint is stalled,
\c
false otherwise.
*
* \ingroup Group_EndpointPacketManagement_UC3
*
*
* \ingroup Group_EndpointPacketManagement_UC3
*
diff --git
a/LUFA/Drivers/USB/Core/UC3/Host_UC3.h
b/LUFA/Drivers/USB/Core/UC3/Host_UC3.h
index
0359e23
..
19169ce
100644
(file)
--- a/
LUFA/Drivers/USB/Core/UC3/Host_UC3.h
+++ b/
LUFA/Drivers/USB/Core/UC3/Host_UC3.h
@@
-233,7
+233,7
@@
}
/** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
}
/** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
- * that the host resume the USB bus and wake up the device, false otherwise.
+ * that the host resume the USB bus and wake up the device,
\c
false otherwise.
*
* \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
*/
*
* \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise.
*/
diff --git
a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
index
916976b
..
184823c
100644
(file)
--- a/
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
+++ b/
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
@@
-495,7
+495,7
@@
USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
}
USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm;
}
- /** Determines if the currently selected endpoint is stalled, false otherwise.
+ /** Determines if the currently selected endpoint is stalled,
\c
false otherwise.
*
* \ingroup Group_EndpointPacketManagement_XMEGA
*
*
* \ingroup Group_EndpointPacketManagement_XMEGA
*
diff --git
a/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
b/Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
index
8112038
..
ad17e6d
100644
(file)
--- a/
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
+++ b/
Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c
@@
-263,7
+263,7
@@
uint8_t ISPTarget_TransferSoftSPIByte(const uint8_t Byte)
/** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command.
* When not asserted, the line is tristated so as not to interfere with normal device operation.
*
/** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command.
* When not asserted, the line is tristated so as not to interfere with normal device operation.
*
- * \param[in] ResetTarget Boolean true when the target should be held in reset, false otherwise
+ * \param[in] ResetTarget Boolean true when the target should be held in reset,
\c
false otherwise
*/
void ISPTarget_ChangeTargetResetLine(const bool ResetTarget)
{
*/
void ISPTarget_ChangeTargetResetLine(const bool ResetTarget)
{
diff --git
a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
index
f2d3a9a
..
f283863
100644
(file)
--- a/
Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
+++ b/
Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
@@
-72,7
+72,7
@@
static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
*
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
*
- * \return Boolean
true if the NVM controller became ready within the timeout period,
false otherwise
+ * \return Boolean
\c true if the NVM controller became ready within the timeout period, \c
false otherwise
*/
bool TINYNVM_WaitWhileNVMBusBusy(void)
{
*/
bool TINYNVM_WaitWhileNVMBusBusy(void)
{
@@
-97,7
+97,7
@@
bool TINYNVM_WaitWhileNVMBusBusy(void)
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
- * \return Boolean
true if the NVM controller became ready within the timeout period,
false otherwise
+ * \return Boolean
\c true if the NVM controller became ready within the timeout period, \c
false otherwise
*/
bool TINYNVM_WaitWhileNVMControllerBusy(void)
{
*/
bool TINYNVM_WaitWhileNVMControllerBusy(void)
{
@@
-121,7
+121,7
@@
bool TINYNVM_WaitWhileNVMControllerBusy(void)
/** Enables the physical TPI interface on the target and enables access to the internal NVM controller.
*
/** Enables the physical TPI interface on the target and enables access to the internal NVM controller.
*
- * \return Boolean
true if the TPI interface was enabled successfully,
false otherwise
+ * \return Boolean
\c true if the TPI interface was enabled successfully, \c
false otherwise
*/
bool TINYNVM_EnableTPI(void)
{
*/
bool TINYNVM_EnableTPI(void)
{
@@
-165,7
+165,7
@@
void TINYNVM_DisableTPI(void)
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Length of the data to read from the device
*
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Length of the data to read from the device
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
uint8_t* ReadBuffer,
*/
bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
uint8_t* ReadBuffer,
@@
-198,7
+198,7
@@
bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteLength Total number of bytes to write to the device (must be an integer multiple of 2)
*
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteLength Total number of bytes to write to the device (must be an integer multiple of 2)
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
uint8_t* WriteBuffer,
*/
bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
uint8_t* WriteBuffer,
@@
-245,7
+245,7
@@
bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool TINYNVM_EraseMemory(const uint8_t EraseCommand,
const uint16_t Address)
*/
bool TINYNVM_EraseMemory(const uint8_t EraseCommand,
const uint16_t Address)
diff --git
a/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
b/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
index
adb9b3c
..
06a4f72
100644
(file)
--- a/
Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
+++ b/
Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
@@
-67,7
+67,7
@@
static void XMEGANVM_SendNVMRegAddress(const uint8_t Register)
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
* calculation.
*
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
* calculation.
*
- * \return Boolean
true if the NVM controller became ready within the timeout period,
false otherwise
+ * \return Boolean
\c true if the NVM controller became ready within the timeout period, \c
false otherwise
*/
bool XMEGANVM_WaitWhileNVMBusBusy(void)
{
*/
bool XMEGANVM_WaitWhileNVMBusBusy(void)
{
@@
-92,7
+92,7
@@
bool XMEGANVM_WaitWhileNVMBusBusy(void)
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
* timeout period expires.
*
- * \return Boolean
true if the NVM controller became ready within the timeout period,
false otherwise
+ * \return Boolean
\c true if the NVM controller became ready within the timeout period, \c
false otherwise
*/
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
{
*/
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
{
@@
-120,7
+120,7
@@
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
/** Enables the physical PDI interface on the target and enables access to the internal NVM controller.
*
/** Enables the physical PDI interface on the target and enables access to the internal NVM controller.
*
- * \return Boolean
true if the PDI interface was enabled successfully,
false otherwise
+ * \return Boolean
\c true if the PDI interface was enabled successfully, \c
false otherwise
*/
bool XMEGANVM_EnablePDI(void)
{
*/
bool XMEGANVM_EnablePDI(void)
{
@@
-170,7
+170,7
@@
void XMEGANVM_DisablePDI(void)
* \param[in] CRCCommand NVM CRC command to issue to the target
* \param[out] CRCDest CRC Destination when read from the target
*
* \param[in] CRCCommand NVM CRC command to issue to the target
* \param[out] CRCDest CRC Destination when read from the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
uint32_t* const CRCDest)
*/
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
uint32_t* const CRCDest)
@@
-221,7
+221,7
@@
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Number of bytes to read
*
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Number of bytes to read
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
uint8_t* ReadBuffer,
*/
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
uint8_t* ReadBuffer,
@@
-258,7
+258,7
@@
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
* \param[in] WriteAddress Address to write to within the target's address space
* \param[in] Byte Byte to write to the target
*
* \param[in] WriteAddress Address to write to within the target's address space
* \param[in] Byte Byte to write to the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
const uint32_t WriteAddress,
*/
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
const uint32_t WriteAddress,
@@
-291,7
+291,7
@@
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteSize Number of bytes to write
*
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteSize Number of bytes to write
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
const uint8_t EraseBuffCommand,
*/
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
const uint8_t EraseBuffCommand,
@@
-368,7
+368,7
@@
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
* \param[in] EraseCommand NVM erase command to send to the device
* \param[in] Address Address inside the memory space to erase
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean
\c
true if the command sequence complete successfully
*/
bool XMEGANVM_EraseMemory(const uint8_t EraseCommand,
const uint32_t Address)
*/
bool XMEGANVM_EraseMemory(const uint8_t EraseCommand,
const uint32_t Address)
diff --git
a/Projects/HIDReportViewer/HIDReportViewer.c
b/Projects/HIDReportViewer/HIDReportViewer.c
index
2250ddf
..
70b2f9e
100644
(file)
--- a/
Projects/HIDReportViewer/HIDReportViewer.c
+++ b/
Projects/HIDReportViewer/HIDReportViewer.c
@@
-314,7
+314,7
@@
void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
*
* \param[in] CurrentItem Pointer to the item the HID report parser is currently working with
*
- * \return Boolean
true if the item should be stored into the HID report structure,
false if it should be discarded
+ * \return Boolean
\c true if the item should be stored into the HID report structure, \c
false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
{
diff --git
a/Projects/Magstripe/Magstripe.c
b/Projects/Magstripe/Magstripe.c
index
539e236
..
85df8b5
100644
(file)
--- a/
Projects/Magstripe/Magstripe.c
+++ b/
Projects/Magstripe/Magstripe.c
@@
-171,7
+171,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)
*
* \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,
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git
a/Projects/MediaController/MediaController.c
b/Projects/MediaController/MediaController.c
index
ea130d3
..
f1bf649
100644
(file)
--- a/
Projects/MediaController/MediaController.c
+++ b/
Projects/MediaController/MediaController.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)
*
* \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,
const uint8_t ReportType, void* ReportData, uint16_t* const ReportSize)
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
const uint8_t ReportType, void* ReportData, uint16_t* const ReportSize)
diff --git
a/Projects/TempDataLogger/Lib/DataflashManager.c
b/Projects/TempDataLogger/Lib/DataflashManager.c
index
bc56e40
..
b99f627
100644
(file)
--- a/
Projects/TempDataLogger/Lib/DataflashManager.c
+++ b/
Projects/TempDataLogger/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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Projects/TempDataLogger/Lib/SCSI.c
b/Projects/TempDataLogger/Lib/SCSI.c
index
c2d0d6f
..
9bbd456
100644
(file)
--- a/
Projects/TempDataLogger/Lib/SCSI.c
+++ b/
Projects/TempDataLogger/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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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)
*
* \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)
*/
static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@
-325,7
+325,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
*
*
* \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)
{
*/
static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
diff --git
a/Projects/TempDataLogger/TempDataLogger.c
b/Projects/TempDataLogger/TempDataLogger.c
index
4aaff1f
..
415ad9f
100644
(file)
--- a/
Projects/TempDataLogger/TempDataLogger.c
+++ b/
Projects/TempDataLogger/TempDataLogger.c
@@
-281,7
+281,7
@@
bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSI
* \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)
*
* \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,
*/
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
uint8_t* const ReportID,
diff --git
a/Projects/Webserver/Lib/DHCPCommon.c
b/Projects/Webserver/Lib/DHCPCommon.c
index
4a1b7cd
..
57402e0
100644
(file)
--- a/
Projects/Webserver/Lib/DHCPCommon.c
+++ b/
Projects/Webserver/Lib/DHCPCommon.c
@@
-72,7
+72,7
@@
uint8_t DHCPCommon_SetOption(uint8_t* DHCPOptionList,
* \param[in] Option DHCP option to retrieve to the list
* \param[out] Destination Buffer where the option's data is to be written to if found
*
* \param[in] Option DHCP option to retrieve to the list
* \param[out] Destination Buffer where the option's data is to be written to if found
*
- * \return Boolean
true if the option was found in the DHCP packet's options list,
false otherwise
+ * \return Boolean
\c true if the option was found in the DHCP packet's options list, \c
false otherwise
*/
bool DHCPCommon_GetOption(const uint8_t* DHCPOptionList,
const uint8_t Option,
*/
bool DHCPCommon_GetOption(const uint8_t* DHCPOptionList,
const uint8_t Option,
diff --git
a/Projects/Webserver/Lib/DHCPServerApp.c
b/Projects/Webserver/Lib/DHCPServerApp.c
index
902258c
..
970458f
100644
(file)
--- a/
Projects/Webserver/Lib/DHCPServerApp.c
+++ b/
Projects/Webserver/Lib/DHCPServerApp.c
@@
-196,7
+196,7
@@
static uint16_t DHCPServerApp_FillDHCPHeader(DHCP_Header_t* const DHCPHeader,
*
* \pre The IP address must be within the same /24 subnet as the virtual webserver.
*
*
* \pre The IP address must be within the same /24 subnet as the virtual webserver.
*
- * \return Boolean
true if the IP has already been leased to a client,
false otherwise.
+ * \return Boolean
\c true if the IP has already been leased to a client, \c
false otherwise.
*/
static bool DHCPServerApp_CheckIfIPLeased(const uip_ipaddr_t* const IPAddress)
{
*/
static bool DHCPServerApp_CheckIfIPLeased(const uip_ipaddr_t* const IPAddress)
{
diff --git
a/Projects/Webserver/Lib/DataflashManager.c
b/Projects/Webserver/Lib/DataflashManager.c
index
bc56e40
..
b99f627
100644
(file)
--- a/
Projects/Webserver/Lib/DataflashManager.c
+++ b/
Projects/Webserver/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.
*
/** 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)
{
*/
bool DataflashManager_CheckDataflashOperation(void)
{
diff --git
a/Projects/Webserver/Lib/SCSI.c
b/Projects/Webserver/Lib/SCSI.c
index
c2d0d6f
..
9bbd456
100644
(file)
--- a/
Projects/Webserver/Lib/SCSI.c
+++ b/
Projects/Webserver/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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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
*
*
* \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)
{
*/
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)
*
* \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)
*/
static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@
-325,7
+325,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
*
*
* \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)
{
*/
static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{