Fix Doxygen errors in demos.

diff --git a/Demos/Device/MassStorage/Lib/SCSI.c b/Demos/Device/MassStorage/Lib/SCSI.c
index 8f3167a..d56e343 100644 (file)
--- 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\r
  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns\r
  *  a command failure due to a ILLEGAL REQUEST.\r
 /** Main routine to process the SCSI command located in the Command Block Wrapper read from the host. This dispatches\r
  *  to the appropriate SCSI command handling routine if the issued command is supported by the device, else it returns\r
  *  a command failure due to a ILLEGAL REQUEST.\r

+ *\r
+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r

  */\r
 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
 {\r
  */\r
 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
 {\r


@@ -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\r
  *  and capabilities to the host.\r
  *\r
 /** Command processing for an issued SCSI INQUIRY command. This command returns information about the device's features\r
  *  and capabilities to the host.\r
  *\r

+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *\r

  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_t* MSInterfaceInfo)\r


@@ -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,\r
  *  including the error code and additional error information so that the host can determine why a command failed to complete.\r
  *\r
 /** Command processing for an issued SCSI REQUEST SENSE command. This command returns information about the last issued command,\r
  *  including the error code and additional error information so that the host can determine why a command failed to complete.\r
  *\r

+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *\r

  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_t* MSInterfaceInfo)\r


@@ -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\r
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.\r
  *\r
 /** Command processing for an issued SCSI READ CAPACITY (10) command. This command returns information about the device's capacity\r
  *  on the selected Logical Unit (drive), as a number of OS-sized blocks.\r
  *\r

+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *\r

  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_t* MSInterfaceInfo)\r


@@ -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\r
  *  supported.\r
  *\r
  *  board, and indicates if they are present and functioning correctly. Only the Self-Test portion of the diagnostic command is\r
  *  supported.\r
  *\r

+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r
+ *\r

  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_t* MSInterfaceInfo)\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r
  */\r
 static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_t* MSInterfaceInfo)\r


@@ -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\r
  *  reading and writing of the data.\r
  *\r
  *  and total number of blocks to process, then calls the appropriate low-level dataflash routine to handle the actual\r
  *  reading and writing of the data.\r
  *\r

+ *  \param MSInterfaceInfo  Pointer to the Mass Storage class interface structure that the command is associated with\r

  *  \param IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r
  *\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r
  *  \param IsDataRead  Indicates if the command is a READ (10) command or WRITE (10) command (DATA_READ or DATA_WRITE)\r
  *\r
  *  \return Boolean true if the command completed successfully, false otherwise.\r

diff --git a/Demos/Device/RNDISEthernet/Lib/ICMP.c b/Demos/Device/RNDISEthernet/Lib/ICMP.c
index ba6e1db..ee87f83 100644 (file)
--- 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\r
  *  to the output Ethernet frame if the host is issuing a ICMP ECHO request.\r
  *\r
 /** Processes an ICMP packet inside an Ethernet frame, and writes the appropriate response\r
  *  to the output Ethernet frame if the host is issuing a ICMP ECHO request.\r
  *\r

+ *  \param FrameIN  Pointer to the incomming Ethernet frame information structure\r

  *  \param InDataStart   Pointer to the start of the incoming packet's ICMP header\r
  *  \param OutDataStart  Pointer to the start of the outgoing packet's ICMP header\r
  *\r
  *  \param InDataStart   Pointer to the start of the incoming packet's ICMP header\r
  *  \param OutDataStart  Pointer to the start of the outgoing packet's ICMP header\r
  *\r

diff --git a/Demos/Device/RNDISEthernet/Lib/IP.c b/Demos/Device/RNDISEthernet/Lib/IP.c
index 0850045..c5c38fc 100644 (file)
--- 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\r
  *  to the output Ethernet frame if one is created by a subprotocol handler.\r
  *\r
 /** Processes an IP packet inside an Ethernet frame, and writes the appropriate response\r
  *  to the output Ethernet frame if one is created by a subprotocol handler.\r
  *\r

+ *  \param FrameIN       Pointer to the incomming Ethernet frame information structure\r

  *  \param InDataStart   Pointer to the start of the incoming packet's IP header\r
  *  \param OutDataStart  Pointer to the start of the outgoing packet's IP header\r
  *\r
  *  \param InDataStart   Pointer to the start of the incoming packet's IP header\r
  *  \param OutDataStart  Pointer to the start of the outgoing packet's IP header\r
  *\r

diff --git a/Demos/Device/RNDISEthernet/Lib/TCP.c b/Demos/Device/RNDISEthernet/Lib/TCP.c
index 1ebd154..7c3f3b4 100644 (file)
--- 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
  *\r
  *  \param TCPHeaderOutStart  Pointer to the start of the packet's outgoing TCP header\r
  *  \param SourceAddress      Source protocol IP address of the outgoing IP header\r
  *\r
  *  \param TCPHeaderOutStart  Pointer to the start of the packet's outgoing TCP header\r
  *  \param SourceAddress      Source protocol IP address of the outgoing IP header\r

- *  \param SourceAddress      DestinationAddress protocol IP address of the outgoing IP header\r
+ *  \param DestinationAddress DestinationAddress protocol IP address of the outgoing IP header\r

  *  \param TCPOutSize         Size in bytes of the TCP data header and payload\r
  *\r
  *  \return A 16-bit TCP checksum value\r
  *  \param TCPOutSize         Size in bytes of the TCP data header and payload\r
  *\r
  *  \return A 16-bit TCP checksum value\r

diff --git a/Demos/OTG/TestApp/TestEvents.c b/Demos/OTG/TestApp/TestEvents.c
index b2f1740..ea7fa4b 100644 (file)
--- a/Demos/OTG/TestApp/TestEvents.c
+++ b/Demos/OTG/TestApp/TestEvents.c
@@ -31,7 +31,7 @@
 /** \file\r
  *\r
  *  This file contains dummy handlers for all the possible USB events passed to the\r
 /** \file\r
  *\r
  *  This file contains dummy handlers for all the possible USB events passed to the\r

- *  application by the library (see \ref Group_Events documentation for more details on USB events).\r
+ *  application by the library (see library documentation for more details on USB events).\r

  *\r
  *  Each event is caught and printed to the USART so that they may be monitored.\r
  */\r
  *\r
  *  Each event is caught and printed to the USART so that they may be monitored.\r
  */\r