From d37d419ffa419911d0488f50f65a77b1f8ecacce Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Thu, 4 Jun 2009 03:12:07 +0000
Subject: [PATCH] Fix Doxygen errors in demos.
---
Demos/Device/MassStorage/Lib/SCSI.c | 11 +++++++++++
Demos/Device/RNDISEthernet/Lib/ICMP.c | 1 +
Demos/Device/RNDISEthernet/Lib/IP.c | 1 +
Demos/Device/RNDISEthernet/Lib/TCP.c | 2 +-
Demos/OTG/TestApp/TestEvents.c | 2 +-
5 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/Demos/Device/MassStorage/Lib/SCSI.c b/Demos/Device/MassStorage/Lib/SCSI.c
index 8f3167a47..d56e343a7 100644
--- a/Demos/Device/MassStorage/Lib/SCSI.c
+++ b/Demos/Device/MassStorage/Lib/SCSI.c
@@ -83,6 +83,8 @@ SCSI_Request_Sense_Response_t SenseData =
/** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches
* 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.
+ *
+ * \param MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
*/
bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_t* MSInterfaceInfo)
{
@@ -140,6 +142,8 @@ bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_t* MSInterfaceInfo)
/** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features
* and capabilities to the host.
*
+ * \param 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.
*/
static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_t* MSInterfaceInfo)
@@ -180,6 +184,8 @@ static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_t* MSInterfaceInfo)
/** 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.
*
+ * \param 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.
*/
static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_t* MSInterfaceInfo)
@@ -202,6 +208,8 @@ static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_t* MSInterfaceInfo)
/** 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.
*
+ * \param 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.
*/
static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_t* MSInterfaceInfo)
@@ -223,6 +231,8 @@ static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_t* MSInterfaceInfo)
* board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is
* supported.
*
+ * \param 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.
*/
static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_t* MSInterfaceInfo)
@@ -286,6 +296,7 @@ static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_t* MSInterfaceInfo)
* and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual
* reading and writing of the data.
*
+ * \param MSInterfaceInfo Pointer to the Mass Storage class interface structure that the command is associated with
* \param 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.
diff --git a/Demos/Device/RNDISEthernet/Lib/ICMP.c b/Demos/Device/RNDISEthernet/Lib/ICMP.c
index ba6e1db68..ee87f8383 100644
--- a/Demos/Device/RNDISEthernet/Lib/ICMP.c
+++ b/Demos/Device/RNDISEthernet/Lib/ICMP.c
@@ -40,6 +40,7 @@
/** Processes an ICMP packet inside an Ethernet frame, and writes the appropriate response
* to the output Ethernet frame if the host is issuing a ICMP ECHO request.
*
+ * \param FrameIN Pointer to the incomming Ethernet frame information structure
* \param InDataStart Pointer to the start of the incoming packet's ICMP header
* \param OutDataStart Pointer to the start of the outgoing packet's ICMP header
*
diff --git a/Demos/Device/RNDISEthernet/Lib/IP.c b/Demos/Device/RNDISEthernet/Lib/IP.c
index 08500450c..c5c38fcad 100644
--- a/Demos/Device/RNDISEthernet/Lib/IP.c
+++ b/Demos/Device/RNDISEthernet/Lib/IP.c
@@ -39,6 +39,7 @@
/** Processes an IP packet inside an Ethernet frame, and writes the appropriate response
* to the output Ethernet frame if one is created by a subprotocol handler.
*
+ * \param FrameIN Pointer to the incomming Ethernet frame information structure
* \param InDataStart Pointer to the start of the incoming packet's IP header
* \param OutDataStart Pointer to the start of the outgoing packet's IP header
*
diff --git a/Demos/Device/RNDISEthernet/Lib/TCP.c b/Demos/Device/RNDISEthernet/Lib/TCP.c
index 1ebd15435..7c3f3b447 100644
--- a/Demos/Device/RNDISEthernet/Lib/TCP.c
+++ b/Demos/Device/RNDISEthernet/Lib/TCP.c
@@ -581,7 +581,7 @@ int16_t TCP_ProcessTCPPacket(void* IPHeaderInStart, void* TCPHeaderInStart, void
*
* \param TCPHeaderOutStart Pointer to the start of the packet's outgoing TCP header
* \param SourceAddress Source protocol IP address of the outgoing IP header
- * \param SourceAddress DestinationAddress protocol IP address of the outgoing IP header
+ * \param DestinationAddress DestinationAddress protocol IP address of the outgoing IP header
* \param TCPOutSize Size in bytes of the TCP data header and payload
*
* \return A 16-bit TCP checksum value
diff --git a/Demos/OTG/TestApp/TestEvents.c b/Demos/OTG/TestApp/TestEvents.c
index b2f174015..ea7fa4b55 100644
--- a/Demos/OTG/TestApp/TestEvents.c
+++ b/Demos/OTG/TestApp/TestEvents.c
@@ -31,7 +31,7 @@
/** \file
*
* This file contains dummy handlers for all the possible USB events passed to the
- * application by the library (see \ref Group_Events documentation for more details on USB events).
+ * application by the library (see library documentation for more details on USB events).
*
* Each event is caught and printed to the USART so that they may be monitored.
*/
--
GitLab