From 234d0a39eb3e261a1ddfcea31d7104e3400b2491 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Mon, 15 Jun 2009 07:23:14 +0000
Subject: [PATCH] Doxygen corrections to fix Doxygen warnings in some demos.

---
 Demos/Device/ClassDriver/GenericHID/GenericHID.c       | 2 ++
 Demos/Device/ClassDriver/Joystick/Joystick.c           | 2 ++
 Demos/Device/ClassDriver/Keyboard/Keyboard.c           | 2 ++
 Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c | 1 +
 Demos/Device/ClassDriver/Mouse/Mouse.c                 | 2 ++
 Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c       | 2 +-
 Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c          | 2 +-
 7 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.c b/Demos/Device/ClassDriver/GenericHID/GenericHID.c
index 6bf761366..58cb6df4e 100644
--- 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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *  \param ReportData  Pointer to a buffer where the created report should be stored
  *
  *  \return Number of bytes written in the report (or zero if no report is to be sent
@@ -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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID of the received report from the host
  *  \param ReportData  Pointer to a buffer where the created report has been stored
  *  \param ReportSize  Size in bytes of the received HID report
  */
diff --git a/Demos/Device/ClassDriver/Joystick/Joystick.c b/Demos/Device/ClassDriver/Joystick/Joystick.c
index 47d6930d0..85f670e61 100644
--- 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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *  \param ReportData  Pointer to a buffer where the created report should be stored
  *
  *  \return Number of bytes written in the report (or zero if no report is to be sent
@@ -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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID of the received report from the host
  *  \param ReportData  Pointer to a buffer where the created report has been stored
  *  \param ReportSize  Size in bytes of the received HID report
  */
diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.c b/Demos/Device/ClassDriver/Keyboard/Keyboard.c
index 6fe36db1f..7318edb8c 100644
--- 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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *  \param ReportData  Pointer to a buffer where the created report should be stored
  *
  *  \return Number of bytes written in the report (or zero if no report is to be sent
@@ -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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID of the received report from the host
  *  \param ReportData  Pointer to a buffer where the created report has been stored
  *  \param ReportSize  Size in bytes of the received HID report
  */
diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c
index 859845db8..1d94f1b26 100644
--- 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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *  \param ReportData  Pointer to a buffer where the created report should be stored
  *
  *  \return Number of bytes written in the report (or zero if no report is to be sent
diff --git a/Demos/Device/ClassDriver/Mouse/Mouse.c b/Demos/Device/ClassDriver/Mouse/Mouse.c
index 4eeb732ff..22c4b5528 100644
--- 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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *  \param ReportData  Pointer to a buffer where the created report should be stored
  *
  *  \return Number of bytes written in the report (or zero if no report is to be sent
@@ -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.
  *
  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param ReportID  Report ID of the received report from the host
  *  \param ReportData  Pointer to a buffer where the created report has been stored
  *  \param ReportSize  Size in bytes of the received HID report
  */
diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c
index 7c3f3b447..44a32ea51 100644
--- 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
  *
  *  \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 DestinationAddress DestinationAddress protocol IP address of the outgoing IP header
+ *  \param DestinationAddress Destination 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/Device/LowLevel/RNDISEthernet/Lib/TCP.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c
index e106e5d74..b7b225a41 100644
--- 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
  *
  *  \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 Destination 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
-- 
GitLab