Fix build and Doxygen errors.

This commit is contained in:
Dean Camera 2009-11-25 03:56:51 +00:00
parent 179691be6e
commit 50f4a3b625
13 changed files with 1502 additions and 10 deletions

View File

@ -192,6 +192,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -136,6 +136,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -130,6 +130,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -131,6 +131,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -159,6 +159,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -181,6 +181,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -130,6 +130,7 @@ void EVENT_USB_Device_StartOfFrame(void)
* *
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
* \param[in] ReportType Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
* \param[out] ReportData Pointer to a buffer where the created report should be stored * \param[out] ReportData Pointer to a buffer where the created report should be stored
* \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent * \param[out] ReportSize Number of bytes written in the report (or zero if no report is to be sent
* *

View File

@ -41,9 +41,9 @@
* routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate * routine will read in the entire configuration descriptor, and configure the hosts pipes to correctly communicate
* with compatible devices. * with compatible devices.
* *
* This routine searches for a CDC interface descriptor containing bulk data IN and OUT endpoints, and an interrupt event endpoint. * This routine searches for a RNDIS interface descriptor containing bulk data IN and OUT endpoints, and an interrupt event endpoint.
* *
* \return An error code from the \ref CDCHost_GetConfigDescriptorDataCodes_t enum. * \return An error code from the \ref RNDISHost_GetConfigDescriptorDataCodes_t enum.
*/ */
uint8_t ProcessConfigurationDescriptor(void) uint8_t ProcessConfigurationDescriptor(void)
{ {

View File

@ -43,7 +43,7 @@ uint32_t RequestID = 0;
/** Function to send the given encapsulated RNDIS command to the device. /** Function to send the given encapsulated RNDIS command to the device.
* *
* \param[in] Buffer Source command data buffer to send to the device * \param[in] Buffer Source command data buffer to send to the device
* \param[in] Bytes Number of bytes to send * \param[in] Length Number of bytes to send
* *
* \return A value from the USB_Host_SendControlErrorCodes_t enum * \return A value from the USB_Host_SendControlErrorCodes_t enum
*/ */
@ -67,7 +67,7 @@ uint8_t RNDIS_SendEncapsulatedCommand(void* Buffer, uint16_t Length)
/** Function to receive the given encapsulated RNDIS response from the device. /** Function to receive the given encapsulated RNDIS response from the device.
* *
* \param[out] Buffer Destination command data buffer to write read data from the device to * \param[out] Buffer Destination command data buffer to write read data from the device to
* \param[in] Bytes Number of bytes to read * \param[in] Length Number of bytes to read
* *
* \return A value from the USB_Host_SendControlErrorCodes_t enum * \return A value from the USB_Host_SendControlErrorCodes_t enum
*/ */

View File

@ -44,8 +44,8 @@ all:
make -C StillImageHost clean make -C StillImageHost clean
make -C StillImageHost all make -C StillImageHost all
make -C RNDISHost clean make -C RNDISEthernetHost clean
make -C RNDISHost all make -C RNDISEthernetHost all
%: %:
make -C CDCHost $@ make -C CDCHost $@
@ -59,4 +59,4 @@ all:
make -C MouseHostWithParser $@ make -C MouseHostWithParser $@
make -C PrinterHost $@ make -C PrinterHost $@
make -C StillImageHost $@ make -C StillImageHost $@
make -C RNDISHost $@ make -C RNDISEthernetHost $@

File diff suppressed because one or more lines are too long

View File

@ -77,7 +77,7 @@
struct struct
{ {
bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
* after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the * after \ref SImage_Host_ConfigurePipes() is called and the Host state machine is in the
* Configured state * Configured state
*/ */
@ -94,7 +94,7 @@
} USB_ClassInfo_SI_Host_t; } USB_ClassInfo_SI_Host_t;
/* Enums: */ /* Enums: */
/** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */ /** Enum for the possible error codes returned by the \ref SImage_Host_ConfigurePipes() function. */
enum SIHost_EnumerationFailure_ErrorCodes_t enum SIHost_EnumerationFailure_ErrorCodes_t
{ {
SI_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */ SI_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */

File diff suppressed because it is too large Load Diff