ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add briefs for the library core structures.

Browse source
This commit is contained in:
Dean Camera 2010-03-29 13:32:36 +00:00
parent 0557676013
commit 9257f4ab8e
73 changed files with 382 additions and 87 deletions
Download patch file Download diff file Expand all files Collapse all files

56
LUFA/Drivers/USB/HighLevel/StdDescriptors.h
View file

@ -211,7 +211,9 @@
};
/* Type Defines: */
/** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure
/** \brief Standard USB Descriptor Header (LUFA naming conventions).
*
* Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
* uses LUFA-specific element names to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names
@ -224,7 +226,9 @@
*/
} USB_Descriptor_Header_t;
/** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure
/** \brief Standard USB Descriptor Header (USB-IF naming conventions).
*
* Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure
* uses the relevant standard's given element names to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names
@ -237,7 +241,9 @@
*/
} USB_StdDescriptor_Header_t;
/** Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
/** \brief Standard USB Device Descriptor (LUFA naming conventions).
*
* Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each
* element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names
@ -284,7 +290,9 @@
*/
} USB_Descriptor_Device_t;
/** Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names
/** \brief Standard USB Device Descriptor (USB-IF naming conventions).
*
* Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names
@ -330,7 +338,9 @@
*/
} USB_StdDescriptor_Device_t;
/** Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names
/** \brief Standard USB Configuration Descriptor (LUFA naming conventions).
*
* Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names
@ -357,7 +367,9 @@
*/
} USB_Descriptor_Configuration_Header_t;
/** Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
/** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).
*
* Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names
@ -383,7 +395,9 @@
*/
} USB_StdDescriptor_Configuration_Header_t;
/** Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Interface Descriptor (LUFA naming conventions).
*
* Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names
@ -409,7 +423,9 @@
*/
} USB_Descriptor_Interface_t;
/** Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
/** \brief Standard USB Interface Descriptor (USB-IF naming conventions).
*
* Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names
* to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names
@ -435,7 +451,9 @@
*/
} USB_StdDescriptor_Interface_t;
/** Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Interface Association Descriptor (LUFA naming conventions).
*
* Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at
@ -462,7 +480,9 @@
*/
} USB_Descriptor_Interface_Association_t;
/** Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
/** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).
*
* Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given
* element names to ensure compatibility with the standard.
*
* This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at
@ -490,7 +510,9 @@
*/
} USB_StdDescriptor_Interface_Association_t;
/** Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names
/** \brief Standard USB Endpoint Descriptor (LUFA naming conventions).
*
* Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names
* to make each element's purpose clearer.
*
* \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names
@ -516,7 +538,9 @@
*/
} USB_Descriptor_Endpoint_t;
/** Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
/** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).
*
* Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given
* element names to ensure compatibility with the standard.
*
* \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific
@ -544,7 +568,9 @@
*/
} USB_StdDescriptor_Endpoint_t;
/** Type define for a standard string descriptor. Unlike other standard descriptors, the length
/** \brief Standard USB String Descriptor (LUFA naming conventions).
*
* Type define for a standard string descriptor. Unlike other standard descriptors, the length
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()
* macro rather than by the size of the descriptor structure, as the length is not fixed.
*
@ -572,7 +598,9 @@
*/
} USB_Descriptor_String_t;
/** Type define for a standard string descriptor. Unlike other standard descriptors, the length
/** \brief Standard USB String Descriptor (USB-IF naming conventions).
*
* Type define for a standard string descriptor. Unlike other standard descriptors, the length
* of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()
* macro rather than by the size of the descriptor structure, as the length is not fixed.
*