Add human readable license information and add some missing module documentation briefs.

This commit is contained in:
Dean Camera 2012-09-01 22:08:59 +00:00
parent 43658f336e
commit 376160e2c0
12 changed files with 43 additions and 13 deletions

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassAOA Android Open Accessory Class Driver
* \brief USB class driver for the Google Android Open Accessory class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassAudio Audio 1.0 Class Driver
* \brief USB class driver for the USB-IF Audio 1.0 class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver
* \brief USB class driver for the USB-IF CDC-ACM (Virtual Serial) class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassHID HID Class Driver
* \brief USB class driver for the USB-IF Human Interface Device (HID) class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassMIDI MIDI Class Driver
* \brief USB class driver for the USB-IF MIDI class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassMS Mass Storage Class Driver
* \brief USB class driver for the USB-IF Bulk-Only Transport Mass Storage class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassPrinter Printer Class Driver
* \brief USB class driver for the USB-IF Printer class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver
* \brief USB class driver for the Microsoft Remote Network Driver Interface Specification (RNDIS) class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -39,6 +39,7 @@
/** \ingroup Group_USBClassDrivers
* \defgroup Group_USBClassSI Still Image Class Driver
* \brief USB class driver for the USB-IF Still Image (PIMA-compliant) class standard.
*
* \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module:

View file

@ -47,8 +47,8 @@
* @{
*/
#ifndef __CONFIGDESCRIPTOR_H__
#define __CONFIGDESCRIPTOR_H__
#ifndef __CONFIGDESCRIPTORS_H__
#define __CONFIGDESCRIPTORS_H__
/* Includes: */
#include "../../../Common/Common.h"
@ -119,16 +119,16 @@
{
HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor. */
HOST_GETCONFIG_DeviceDisconnect = 1, /**< The attached device was disconnected while retrieving the configuration
* descriptor.
*/
* descriptor.
*/
HOST_GETCONFIG_PipeError = 2, /**< An error occurred in the pipe while sending the request. */
HOST_GETCONFIG_SetupStalled = 3, /**< The attached device stalled the request to retrieve the configuration
* descriptor.
*/
* descriptor.
*/
HOST_GETCONFIG_SoftwareTimeOut = 4, /**< The request or data transfer timed out. */
HOST_GETCONFIG_BuffOverflow = 5, /**< The device's configuration descriptor is too large to fit into the allocated
* buffer.
*/
* buffer.
*/
HOST_GETCONFIG_InvalidData = 6, /**< The device returned invalid configuration descriptor data. */
};