Add file-level brief documentation.

Remove accidentally duplicated model-specific peripheral driver files.

8 files changed, 79 insertions, 1 deletions

diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h
index c7abbd2f4..44913dbb5 100644
--- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h
+++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h
@@ -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__

 

diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index 6c8a4b213..ceb454934 100644
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.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

  *

diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h
index ae4086779..389d3c458 100644
--- a/LUFA/Drivers/USB/LowLevel/Endpoint.h
+++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h
@@ -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

  *

diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index ea404f2b1..a8a5b0131 100644
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -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

  *

diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h
index e2132d934..e38c67e6c 100644
--- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h
+++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h
@@ -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__

 

diff --git a/LUFA/Drivers/USB/LowLevel/LowLevel.h b/LUFA/Drivers/USB/LowLevel/LowLevel.h
index e99bd1f0a..04b2c460c 100644
--- a/LUFA/Drivers/USB/LowLevel/LowLevel.h
+++ b/LUFA/Drivers/USB/LowLevel/LowLevel.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

  *

diff --git a/LUFA/Drivers/USB/LowLevel/OTG.h b/LUFA/Drivers/USB/LowLevel/OTG.h
index 26b2cd5c5..ef3ab38d1 100644
--- a/LUFA/Drivers/USB/LowLevel/OTG.h
+++ b/LUFA/Drivers/USB/LowLevel/OTG.h
@@ -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

  *

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index c22c5aeb0..127cea3ab 100644
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -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

  *