Add briefs for the library core structures.

6 files changed, 31 insertions, 7 deletions

diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index 9677339ca..053b69aab 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device mode driver for the library USB Audio 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.

  */

@@ -68,8 +70,10 @@
 		#endif

 

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

-		/* Type Defines: */		

-			/** Class state structure. An instance of this structure should be made for each Audio interface

+		/* Type Defines: */

+			/** \brief Audio Class Device Mode Configuration and State Structure.

+			 *

+			 *  Class state structure. An instance of this structure should be made for each Audio interface

 			 *  within the user application, and passed to each of the Audio class driver functions as the

 			 *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index adf1708ce..2c5c30afd 100644
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device 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/CDC.h.

  */

@@ -87,7 +89,9 @@
 		

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

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made for each CDC interface

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

+			 *

+			 *  Class state structure. An instance of this structure should be made for each CDC interface

 			 *  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/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 009018437..1ab71771f 100644
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device 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.

  */

@@ -69,7 +71,9 @@
 

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

 		/* Type Defines: */

-			/** Class state structure. An instance of this structure should be made for each HID interface

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

+			 *

+			 *  Class state structure. An instance of this structure should be made for each HID interface

 			 *  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/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h
index 9eaabbc5e..11a05bfbb 100644
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device 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.

  */

@@ -69,7 +71,9 @@
 

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

 		/* Type Define: */

-			/** Class state structure. An instance of this structure should be made for each MIDI interface

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

+			 *

+			 *  Class state structure. An instance of this structure should be made for each MIDI interface

 			 *  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/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h
index 67bbfab91..8eb150be9 100644
--- a/LUFA/Drivers/USB/Class/Device/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device 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.

  */

@@ -69,7 +71,9 @@
 

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

 		/* Type Defines: */										

-			/** Class state structure. An instance of this structure should be made for each Mass Storage interface

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

+			 *

+			 *  Class state structure. An instance of this structure should be made for each Mass Storage interface

 			 *  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.

 			 */

diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h
index 5d541f18b..5408ec70a 100644
--- a/LUFA/Drivers/USB/Class/Device/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h
@@ -31,6 +31,8 @@
 /** \file

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

  *

+ *  Device 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.

  */

@@ -69,7 +71,9 @@
 		

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

 		/* Type Defines: */					 

-			/** Class state structure. An instance of this structure should be made for each RNDIS interface

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

+			 *

+			 *  Class state structure. An instance of this structure should be made for each RNDIS interface

 			 *  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.

 			 */