Commit 234d0a39 authored by Dean Camera's avatar Dean Camera
Browse files

Doxygen corrections to fix Doxygen warnings in some demos.

parent b7049da1
...@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) ...@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID class driver callback function for the creation of HID reports to the host. /** 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 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 * \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 * \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 ...@@ -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. /** 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 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 ReportData Pointer to a buffer where the created report has been stored
* \param ReportSize Size in bytes of the received HID report * \param ReportSize Size in bytes of the received HID report
*/ */
......
...@@ -128,6 +128,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) ...@@ -128,6 +128,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID class driver callback function for the creation of HID reports to the host. /** 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 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 * \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 * \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 ...@@ -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. /** 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 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 ReportData Pointer to a buffer where the created report has been stored
* \param ReportSize Size in bytes of the received HID report * \param ReportSize Size in bytes of the received HID report
*/ */
......
...@@ -129,6 +129,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) ...@@ -129,6 +129,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID class driver callback function for the creation of HID reports to the host. /** 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 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 * \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 * \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 ...@@ -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. /** 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 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 ReportData Pointer to a buffer where the created report has been stored
* \param ReportSize Size in bytes of the received HID report * \param ReportSize Size in bytes of the received HID report
*/ */
......
...@@ -152,6 +152,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) ...@@ -152,6 +152,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID class driver callback function for the creation of HID reports to the host. /** 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 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 * \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 * \return Number of bytes written in the report (or zero if no report is to be sent
......
...@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) ...@@ -126,6 +126,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
/** HID class driver callback function for the creation of HID reports to the host. /** 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 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 * \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 * \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 ...@@ -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. /** 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 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 ReportData Pointer to a buffer where the created report has been stored
* \param ReportSize Size in bytes of the received HID report * \param ReportSize Size in bytes of the received HID report
*/ */
......
...@@ -581,7 +581,7 @@ int16_t TCP_ProcessTCPPacket(void* IPHeaderInStart, void* TCPHeaderInStart, void ...@@ -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 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 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 * \param TCPOutSize Size in bytes of the TCP data header and payload
* *
* \return A 16-bit TCP checksum value * \return A 16-bit TCP checksum value
......
...@@ -581,7 +581,7 @@ int16_t TCP_ProcessTCPPacket(void* IPHeaderInStart, void* TCPHeaderInStart, void ...@@ -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 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 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 * \param TCPOutSize Size in bytes of the TCP data header and payload
* *
* \return A 16-bit TCP checksum value * \return A 16-bit TCP checksum value
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment