diff options
author | Dean Camera <[email protected]> | 2013-03-18 19:24:55 +0000 |
---|---|---|
committer | Dean Camera <[email protected]> | 2013-03-18 19:24:55 +0000 |
commit | 03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch) | |
tree | 26aca239e281055455d88b9d44a8a1c52b97beb1 /Demos/Device/LowLevel/MassStorage | |
parent | 88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff) | |
download | qmk_firmware-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz qmk_firmware-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip |
Minor documentation improvements.
Diffstat (limited to 'Demos/Device/LowLevel/MassStorage')
-rw-r--r-- | Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c | 2 | ||||
-rw-r--r-- | Demos/Device/LowLevel/MassStorage/Lib/SCSI.c | 14 | ||||
-rw-r--r-- | Demos/Device/LowLevel/MassStorage/MassStorage.c | 2 |
3 files changed, 9 insertions, 9 deletions
diff --git a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c index 7d17a4e6b0..b524aa84b9 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c +++ b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c @@ -497,7 +497,7 @@ void DataflashManager_ResetDataflashProtections(void) /** Performs a simple test on the attached Dataflash IC(s) to ensure that they are working. * - * \return Boolean true if all media chips are working, false otherwise + * \return Boolean \c true if all media chips are working, \c false otherwise */ bool DataflashManager_CheckDataflashOperation(void) { diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c index f9e61a5fac..f874956b61 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c +++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.c @@ -84,7 +84,7 @@ static SCSI_Request_Sense_Response_t SenseData = * to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns * a command failure due to a ILLEGAL REQUEST. * - * \return Boolean true if the command completed successfully, false otherwise + * \return Boolean \c true if the command completed successfully, \c false otherwise */ bool SCSI_DecodeSCSICommand(void) { @@ -146,7 +146,7 @@ bool SCSI_DecodeSCSICommand(void) /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features * and capabilities to the host. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Inquiry(void) { @@ -183,7 +183,7 @@ static bool SCSI_Command_Inquiry(void) /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command, * including the error code and additional error information so that the host can determine why a command failed to complete. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Request_Sense(void) { @@ -208,7 +208,7 @@ static bool SCSI_Command_Request_Sense(void) /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity * on the selected Logical Unit (drive), as a number of OS-sized blocks. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Read_Capacity_10(void) { @@ -235,7 +235,7 @@ static bool SCSI_Command_Read_Capacity_10(void) * board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is * supported. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_Send_Diagnostic(void) { @@ -273,7 +273,7 @@ static bool SCSI_Command_Send_Diagnostic(void) * * \param[in] IsDataRead Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE) * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead) { @@ -325,7 +325,7 @@ static bool SCSI_Command_ReadWrite_10(const bool IsDataRead) /** Command processing for an issued SCSI MODE SENSE (6) command. This command returns various informational pages about * the SCSI device, as well as the device's Write Protect status. * - * \return Boolean true if the command completed successfully, false otherwise. + * \return Boolean \c true if the command completed successfully, \c false otherwise. */ static bool SCSI_Command_ModeSense_6(void) { diff --git a/Demos/Device/LowLevel/MassStorage/MassStorage.c b/Demos/Device/LowLevel/MassStorage/MassStorage.c index 2243b7fe24..7e8bcc4e57 100644 --- a/Demos/Device/LowLevel/MassStorage/MassStorage.c +++ b/Demos/Device/LowLevel/MassStorage/MassStorage.c @@ -222,7 +222,7 @@ void MassStorage_Task(void) /** Function to read in a command block from the host, via the bulk data OUT endpoint. This function reads in the next command block * if one has been issued, and performs validation to ensure that the block command is valid. * - * \return Boolean true if a valid command block has been read in from the endpoint, false otherwise + * \return Boolean \c true if a valid command block has been read in from the endpoint, \c false otherwise */ static bool ReadInCommandBlock(void) { |