Add file-level brief documentation.

Remove accidentally duplicated model-specific peripheral driver files.
2010-03-29 07:49:58 +00:00
parent ec19436d54
commit 0557676013
111 changed files with 1039 additions and 453 deletions
@@ -28,6 +28,16 @@
  this software.
 */

+/** \file
+ *  \brief USB device standard request management.
+ *
+ *  This file contains the function prototypes neccesary for the processing of incomming standard control requests
+ *  when the library is in USB device mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 #ifndef __DEVCHAPTER9_H__
 #define __DEVCHAPTER9_H__

@@ -27,7 +27,16 @@
  arising out of or in connection with the use or performance of
  this software.
 */
- 
+
+/** \file
+ *  \brief USB device mode definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to USB device mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 /** \ingroup Group_USB
 *  @defgroup Group_Device Device Management
 *
@@ -28,6 +28,16 @@
  this software.
 */

+/** \file
+ *  \brief USB device endpoint management definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to the management of the device's
+ *  data endpoints when the library is initialized in USB device mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 /** \ingroup Group_USB
 *  @defgroup Group_EndpointManagement Endpoint Management
 *
@@ -28,6 +28,15 @@
  this software.
 */

+/** \file
+ *  \brief USB host mode definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to USB host mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 /** \ingroup Group_USB
 *  @defgroup Group_Host Host Management
 *
@@ -28,6 +28,16 @@
  this software.
 */

+/** \file
+ *  \brief USB host standard request management.
+ *
+ *  This file contains the function prototypes neccesary for the issuing of outgoing standard control requests
+ *  when the library is in USB host mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 #ifndef __HOSTCHAPTER9_H__
 #define __HOSTCHAPTER9_H__

@@ -28,6 +28,16 @@
  this software.
 */

+/** \file
+ *  \brief USB low level USB controller definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to the low level configutation of the
+ *  USB controller, to start, stop and reset the USB library core.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+ 
 /** \ingroup Group_USB
 *  @defgroup Group_USBManagement USB Interface Management
 *
@@ -28,6 +28,16 @@
  this software.
 */
 
+/** \file
+ *  \brief USB OTG mode definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to USB OTG mode, where two USB devices
+ *  may be linked directly together and exchange host/device roles as needed.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
 /** \ingroup Group_USB
 *  @defgroup Group_OTG USB On The Go (OTG) Management
 *
@@ -28,6 +28,16 @@
  this software.
 */
 
+/** \file
+ *  \brief USB host pipe management definitions.
+ *
+ *  This file contains structures, function prototypes and macros related to the management of the device's
+ *  data pipes when the library is initialized in USB host mode.
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */ 
+
 /** \ingroup Group_USB
 *  @defgroup Group_PipeManagement Pipe Management
 *