Doxygen corrections to fix Doxygen warnings in some demos.

diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.c b/Demos/Device/ClassDriver/GenericHID/GenericHID.c
index 6bf7613..58cb6df 100644 (file)
--- a/Demos/Device/ClassDriver/GenericHID/GenericHID.c
+++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.c
@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 /** HID class driver callback function for the creation of HID reports to the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
  *  \param ReportData  Pointer to a buffer where the created report should be stored\r
  *\r
  *  \return Number of bytes written in the report (or zero if no report is to be sent\r
@@ -140,6 +141,7 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceIn
 /** HID class driver callback function for the processing of HID reports from the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID of the received report from the host\r
  *  \param ReportData  Pointer to a buffer where the created report has been stored\r
  *  \param ReportSize  Size in bytes of the received HID report\r
  */\r

diff --git a/Demos/Device/ClassDriver/Joystick/Joystick.c b/Demos/Device/ClassDriver/Joystick/Joystick.c
index 47d6930..85f670e 100644 (file)
--- a/Demos/Device/ClassDriver/Joystick/Joystick.c
+++ b/Demos/Device/ClassDriver/Joystick/Joystick.c
@@ -128,6 +128,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 /** HID class driver callback function for the creation of HID reports to the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
  *  \param ReportData  Pointer to a buffer where the created report should be stored\r
  *\r
  *  \return Number of bytes written in the report (or zero if no report is to be sent\r
@@ -161,6 +162,7 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceIn
 /** HID class driver callback function for the processing of HID reports from the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID of the received report from the host\r
  *  \param ReportData  Pointer to a buffer where the created report has been stored\r
  *  \param ReportSize  Size in bytes of the received HID report\r
  */\r

diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.c b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
index 6fe36db..7318edb 100644 (file)
--- a/Demos/Device/ClassDriver/Keyboard/Keyboard.c
+++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
@@ -129,6 +129,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 /** HID class driver callback function for the creation of HID reports to the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
  *  \param ReportData  Pointer to a buffer where the created report should be stored\r
  *\r
  *  \return Number of bytes written in the report (or zero if no report is to be sent\r
@@ -162,6 +163,7 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceIn
 /** HID class driver callback function for the processing of HID reports from the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID of the received report from the host\r
  *  \param ReportData  Pointer to a buffer where the created report has been stored\r
  *  \param ReportSize  Size in bytes of the received HID report\r
  */\r

diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
index 859845d..1d94f1b 100644 (file)
--- a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
+++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
@@ -152,6 +152,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 /** HID class driver callback function for the creation of HID reports to the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
  *  \param ReportData  Pointer to a buffer where the created report should be stored\r
  *\r
  *  \return Number of bytes written in the report (or zero if no report is to be sent\r

diff --git a/Demos/Device/ClassDriver/Mouse/Mouse.c b/Demos/Device/ClassDriver/Mouse/Mouse.c
index 4eeb732..22c4b55 100644 (file)
--- a/Demos/Device/ClassDriver/Mouse/Mouse.c
+++ b/Demos/Device/ClassDriver/Mouse/Mouse.c
@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 /** HID class driver callback function for the creation of HID reports to the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
  *  \param ReportData  Pointer to a buffer where the created report should be stored\r
  *\r
  *  \return Number of bytes written in the report (or zero if no report is to be sent\r
@@ -159,6 +160,7 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceIn
 /** HID class driver callback function for the processing of HID reports from the host.\r
  *\r
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportID  Report ID of the received report from the host\r
  *  \param ReportData  Pointer to a buffer where the created report has been stored\r
  *  \param ReportSize  Size in bytes of the received HID report\r
  */\r

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
index 7c3f3b4..44a32ea 100644 (file)
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
+++ b/Demos/Device/ClassDriver/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
- *  \param DestinationAddress DestinationAddress protocol IP address of the outgoing IP header\r
+ *  \param DestinationAddress Destination 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

diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
index e106e5d..b7b225a 100644 (file)
--- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
+++ b/Demos/Device/LowLevel/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
- *  \param SourceAddress      DestinationAddress protocol IP address of the outgoing IP header\r
+ *  \param DestinationAddress Destination 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