aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/Webserver
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
committerDean Camera <dean@fourwalledcubicle.com>2013-03-18 19:24:55 +0000
commit03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch)
tree26aca239e281055455d88b9d44a8a1c52b97beb1 /Projects/Webserver
parent88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff)
downloadlufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.bz2
lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip
Minor documentation improvements.
Diffstat (limited to 'Projects/Webserver')
-rw-r--r--Projects/Webserver/Lib/DHCPCommon.c2
-rw-r--r--Projects/Webserver/Lib/DHCPServerApp.c2
-rw-r--r--Projects/Webserver/Lib/DataflashManager.c2
-rw-r--r--Projects/Webserver/Lib/SCSI.c14
4 files changed, 10 insertions, 10 deletions
diff --git a/Projects/Webserver/Lib/DHCPCommon.c b/Projects/Webserver/Lib/DHCPCommon.c
index 4a1b7cd4c..57402e094 100644
--- 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
*
- * \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,
diff --git a/Projects/Webserver/Lib/DHCPServerApp.c b/Projects/Webserver/Lib/DHCPServerApp.c
index 902258c77..970458f45 100644
--- 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.
*
- * \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)
{
diff --git a/Projects/Webserver/Lib/DataflashManager.c b/Projects/Webserver/Lib/DataflashManager.c
index bc56e4094..b99f6272b 100644
--- 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.
*
- * \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/Projects/Webserver/Lib/SCSI.c b/Projects/Webserver/Lib/SCSI.c
index c2d0d6f11..9bbd4565d 100644
--- 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
*
- * \return Boolean true if the command completed successfully, false otherwise
+ * \return Boolean \c true if the command completed successfully, \c false otherwise
*/
bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -150,7 +150,7 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \return Boolean true if the command completed successfully, false otherwise.
+ * \return Boolean \c true if the command completed successfully, \c false otherwise.
*/
static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -188,7 +188,7 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \return Boolean true if the command completed successfully, false otherwise.
+ * \return Boolean \c true if the command completed successfully, \c false otherwise.
*/
static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -210,7 +210,7 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterf
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \return Boolean true if the command completed successfully, false otherwise.
+ * \return Boolean \c true if the command completed successfully, \c false otherwise.
*/
static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -233,7 +233,7 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInt
*
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*
- * \return Boolean true if the command completed successfully, false otherwise.
+ * \return Boolean \c true if the command completed successfully, \c false otherwise.
*/
static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
{
@@ -272,7 +272,7 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInte
* \param[in] MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
* \param[in] IsDataRead Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)
*
- * \return Boolean true if the command completed successfully, false otherwise.
+ * \return Boolean \c true if the command completed successfully, \c false otherwise.
*/
static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
const bool IsDataRead)
@@ -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
*
- * \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)
{