Add briefs for the library core structures.

9 files changed, 78 insertions, 20 deletions

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 205bb3d57..bb12c082b 100644
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -29,10 +29,12 @@
 */

 

 /** \file

- *  \brief Host mode driver for the library USB Audio Class driver.

+ *  \brief Host mode driver for the library USB CDC Class driver.

+ *

+ *  Host mode driver for the library USB CDC Class driver.

  *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

- *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.

+ *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.

  */

 

 /** \ingroup Group_USBClassCDC

@@ -70,7 +72,9 @@
 

 	/* Public Interface - May be used in end-application: */

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief CDC Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the CDC class driver functions as the CDCInterfaceInfo parameter. This

 			 *  stores each CDC interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index fd0227e6c..29c390a1e 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB HID Class driver.

  *

+ *  Host mode driver for the library USB HID Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.

  */

@@ -73,7 +75,9 @@
 			#define HID_ERROR_LOGICAL              0x80

 	

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief HID Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This

 			 *  stores each HID interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h
index 377a8217c..13f68a045 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h
@@ -31,8 +31,8 @@
 /** \file

  *  \brief USB Human Interface Device (HID) Class report descriptor parser.

  *

- *  This file allows for the easy parsing of the complex HID report descriptor, which describes the data that

- *  the device transmits to the host. It also provides an easy API for extracting and processing the data

+ *  This file allows for the easy parsing of complex HID report descriptors, which describes the data that

+ *  a HID device transmits to the host. It also provides an easy API for extracting and processing the data

  *  elements inside a HID report sent from an attached HID device.

  */

  

@@ -157,28 +157,39 @@
 			};

 		

 		/* Type Defines: */		

-			/** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */

+			/** \brief HID Parser Report Item Min/Max Structure.

+			 *

+			 *  Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max).

+			 */

 			typedef struct

 			{

 				uint32_t                     Minimum; /**< Minimum value for the attribute. */

 				uint32_t                     Maximum; /**< Maximum value for the attribute. */

 			} HID_MinMax_t;

 

-			/** Type define for the Unit attributes of a report item. */

+			/** \brief HID Parser Report Item Unit Structure.

+			 *

+			 *  Type define for the Unit attributes of a report item.

+			 */

 			typedef struct

 			{

 				uint32_t                     Type;     /**< Unit type (refer to HID specifications for details). */

 				uint8_t                      Exponent; /**< Unit exponent (refer to HID specifications for details). */

 			} HID_Unit_t;

 			

-			/** Type define for the Usage attributes of a report item. */

+			/** \brief HID Parser Report Item Usage Structure.

+			 *

+			 *  Type define for the Usage attributes of a report item.

+			 */

 			typedef struct

 			{

 				uint16_t                     Page;   /**< Usage page of the report item. */

 				uint16_t                     Usage;  /**< Usage of the report item. */

 			} HID_Usage_t;

 

-			/** Type define for a COLLECTION object. Contains the collection attributes and a reference to the

+			/** \brief HID Parser Report Item Collection Path Structure.

+			 *

+			 *  Type define for a COLLECTION object. Contains the collection attributes and a reference to the

 			 *  parent collection if any.

 			 */

 			typedef struct CollectionPath

@@ -188,7 +199,10 @@
 				struct CollectionPath*       Parent; /**< Reference to parent collection, or NULL if root collection. */

 			} HID_CollectionPath_t;

 

-			/** Type define for all the data attributes of a report item, except flags. */

+			/** \brief HID Parser Report Item Attributes Structure.

+			 *

+			 *  Type define for all the data attributes of a report item, except flags.

+			 */

 			typedef struct

 			{

 				uint8_t                      BitSize;  /**< Size in bits of the report item's data. */

@@ -199,7 +213,10 @@
 				HID_MinMax_t                 Physical; /**< Physical minimum and maximum of the report item. */

 			} HID_ReportItem_Attributes_t;

 			

-			/** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */

+			/** \brief HID Parser Report Item Details Structure.

+			 *

+			 *  Type define for a report item (IN, OUT or FEATURE) layout attributes and other details.

+			 */

 			typedef struct

 			{

 				uint16_t                     BitOffset;      /**< Bit offset in the IN, OUT or FEATURE report of the item. */

@@ -216,7 +233,10 @@
 				uint32_t                     PreviousValue;  /**< Previous value of the report item. */ 

 			} HID_ReportItem_t;

 			

-			/** Type define for a report item size information structure */

+			/** \brief HID Parser Report Size Structure.

+			 *

+			 *  Type define for a report item size information structure, to retain the size of a device's reports by ID.

+			 */

 			typedef struct

 			{

 				uint8_t                      ReportID; /** Report ID of the report within the HID interface */

@@ -225,7 +245,10 @@
 																 */

 			} HID_ReportSizeInfo_t;

 

-			/** Type define for a complete processed HID report, including all report item data and collections. */

+			/** \brief HID Parser State Structure.

+			 *

+			 *  Type define for a complete processed HID report, including all report item data and collections.

+			 */

 			typedef struct

 			{

 				uint8_t                      TotalReportItems; /**< Total number of report items stored in the

diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
index 197e62b03..4f328c964 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDReportData.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
@@ -31,7 +31,8 @@
 /** \file

  *  \brief Constants for HID report item attributes.

  *

- *  Refer to the HID specification for details on each flag's meaning when applied to an IN, OUT or FEATURE item.

+ *  HID report item constants for report item attributes. Refer to the HID specification for

+ *  details on each flag's meaning when applied to an IN, OUT or FEATURE item.

  */

 

 /** \ingroup Group_HIDParser

diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h
index e0ab9775b..0cd99bcca 100644
--- a/LUFA/Drivers/USB/Class/Host/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB MIDI Class driver.

  *

+ *  Host mode driver for the library USB MIDI Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.

  */

@@ -67,7 +69,9 @@
 		

 	/* Public Interface - May be used in end-application: */

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief MIDI Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the MIDI class driver functions as the MIDIInterfaceInfo parameter. This

 			 *  stores each MIDI interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index 8868c9515..3dbf64940 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB Mass Storage Class driver.

  *

+ *  Host mode driver for the library USB Mass Storage Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.

  */

@@ -71,7 +73,9 @@
 			#define MS_ERROR_LOGICAL_CMD_FAILED              0x80

 	

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief Mass Storage Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This

 			 *  stores each Mass Storage interface's configuration and state information.

 			 */

@@ -105,7 +109,9 @@
 						  */

 			} USB_ClassInfo_MS_Host_t;

 			

-			/** SCSI capacity structure, to hold the total capacity of the device in both the number

+			/** \brief SCSI Device LUN Capacity Structure.

+			 *

+			 *  SCSI capacity structure, to hold the total capacity of the device in both the number

 			 *  of blocks in the current LUN, and the size of each block. This structure is filled by

 			 *  the device when the MassStore_ReadCapacity() function is called.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h
index dc45780c2..04286ca32 100644
--- a/LUFA/Drivers/USB/Class/Host/Printer.h
+++ b/LUFA/Drivers/USB/Class/Host/Printer.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB Printer Class driver.

  *

+ *  Host mode driver for the library USB Printer Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/Printer.h.

  */

@@ -67,7 +69,9 @@
 

 	/* Public Interface - May be used in end-application: */

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief Printer Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This

 			 *  stores each Printer interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h
index 5641620b7..f64710d5b 100644
--- a/LUFA/Drivers/USB/Class/Host/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB RNDIS Class driver.

  *

+ *  Host mode driver for the library USB RNDIS Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h.

  */

@@ -71,7 +73,9 @@
 

 	/* Public Interface - May be used in end-application: */

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made within the user application,

+			/** \brief RNDIS Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

 			 *  and passed to each of the RNDIS class driver functions as the RNDISInterfaceInfo parameter. This

 			 *  stores each RNDIS interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index 8a3714498..4a5ccfabd 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -31,6 +31,8 @@
 /** \file

  *  \brief Host mode driver for the library USB Still Image Class driver.

  *

+ *  Host mode driver for the library USB Still Image Class driver.

+ *

  *  \note This file should not be included directly. It is automatically included as needed by the class driver

  *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.

  */

@@ -71,6 +73,12 @@
 			#define SI_ERROR_LOGICAL_CMD_FAILED              0x80

 

 		/* Type Defines: */

+			/** \brief Still Image Class Host Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made within the user application,

+			 *  and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This

+			 *  stores each Still Image interface's configuration and state information.

+			 */

 			typedef struct

 			{

 				const struct