diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-04-17 05:04:21 +0000 |
commit | d38fa49cb6cb3804c9bb17601688a62ba466b535 (patch) | |
tree | 15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Drivers/USB/LowLevel | |
parent | 6380d057f8911f5d09bdffff4220aa9602df49e2 (diff) | |
download | lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.bz2 lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip |
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Drivers/USB/LowLevel')
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/DevChapter9.h | 8 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/Device.h | 9 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/Endpoint.h | 9 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/Host.h | 9 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/HostChapter9.h | 8 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/LowLevel.h | 6 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/OTG.h | 12 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/Pipe.h | 18 |
8 files changed, 17 insertions, 62 deletions
diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h index 6571659c1..23b7b4620 100644 --- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h @@ -28,14 +28,6 @@ this software.
*/
-/** \file
- *
- * Module for device mode request processing. This module allows for the processing of standard control
- * requests to the default control endpoint while in device mode.
- *
- * \see Chapter 9 of the USB 2.0 specification.
- */
-
#ifndef __DEVCHAPTER9_H__
#define __DEVCHAPTER9_H__
diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 8a2ee00c3..3c2bb3697 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -27,17 +27,12 @@ arising out of or in connection with the use or performance of
this software.
*/
-
-/** \file
- *
- * USB Device mode related macros and enums. This module contains macros and enums which are used when
- * the USB controller is initialized in device mode.
- */
/** \ingroup Group_USB
* @defgroup Group_Device Device Management
*
- * Functions, macros, variables, enums and types related to the management of a USB device when in Device mode.
+ * USB Device mode related macros and enums. This module contains macros and enums which are used when
+ * the USB controller is initialized in device mode.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index a7a282258..651c0e8e6 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -28,17 +28,12 @@ this software.
*/
-/** \file
+/** \ingroup Group_USB
+ * @defgroup Group_EndpointManagement Endpoint Management
*
* Functions, macros and enums related to endpoint management when in USB Device mode. This
* module contains the endpoint management macros, as well as endpoint interrupt and data
* send/recieve functions for various data types.
- */
-
-/** \ingroup Group_USB
- * @defgroup Group_EndpointManagement Endpoint Management
- *
- * Functions, macros, variables, enums and types related to the setup and management of endpoints while in USB Device mode.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index 1ff2d7ab2..82cceb2c0 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -28,16 +28,11 @@ this software.
*/
-/** \file
- *
- * USB Host mode related macros and enums. This module contains macros and enums which are used when
- * the USB controller is initialized in host mode.
- */
-
/** \ingroup Group_USB
* @defgroup Group_Host Host Management
*
- * Functions, macros, variables, enums and types related to the management of a USB host when in Host mode.
+ * USB Host mode related macros and enums. This module contains macros and enums which are used when
+ * the USB controller is initialized in host mode.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h index 8e7695b34..c2c4ece7a 100644 --- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h @@ -28,14 +28,6 @@ this software.
*/
-/** \file
- *
- * Module for host mode request processing. This module allows for the transmission of standard, class and
- * vendor control requests to the default control endpoint of an attached device while in host mode.
- *
- * \see Chapter 9 of the USB 2.0 specification.
- */
-
#ifndef __HOSTCHAPTER9_H__
#define __HOSTCHAPTER9_H__
diff --git a/LUFA/Drivers/USB/LowLevel/LowLevel.h b/LUFA/Drivers/USB/LowLevel/LowLevel.h index a6f506f3b..5c474df70 100644 --- a/LUFA/Drivers/USB/LowLevel/LowLevel.h +++ b/LUFA/Drivers/USB/LowLevel/LowLevel.h @@ -28,12 +28,6 @@ this software.
*/
-/** \file
- *
- * Main low level USB driver. This module manages the low level initialization and shut down of the USB AVR's
- * USB interface in either device or (if supported) host mode.
- */
-
/** \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 caef82cb6..da303c909 100644 --- a/LUFA/Drivers/USB/LowLevel/OTG.h +++ b/LUFA/Drivers/USB/LowLevel/OTG.h @@ -27,19 +27,13 @@ arising out of or in connection with the use or performance of
this software.
*/
-
-/** \file
- *
- * Macros for embedded USB hosts with dual role On The Go capabilities, for managing role exchange. OTG
- * is a way for two USB dual role devices to talk to one another directly without fixed device/host roles.
- *
- * \note These macros are only for AVRs which support the OTG protocol, and do not exist for device-only AVRs.
- */
/** \ingroup Group_USB
* @defgroup Group_OTGManagement USB On The Go (OTG) Management
*
- * Functions, macros, variables, enums and types related to the setup and management of dual role devices.
+ * This module contains macros for embedded USB hosts with dual role On The Go capabilities, for managing role
+ * exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host
+ * roles.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index 9d8dded04..15be81e13 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -27,18 +27,13 @@ arising out of or in connection with the use or performance of
this software.
*/
-
-/** \file
- *
- * Functions, macros and enums related to pipe management when in USB Host mode. This
- * module contains the pipe management macros, as well as pipe interrupt and data
- * send/recieve functions for various data types.
- */
/** \ingroup Group_USB
* @defgroup Group_PipeManagement Pipe Management
*
- * Functions, macros, variables, enums and types related to the setup and management of pipes while in USB Device mode.
+ * This module contains functions, macros and enums related to pipe management when in USB Host mode. This
+ * module contains the pipe management macros, as well as pipe interrupt and data send/recieve functions
+ * for various data types.
*
* @{
*/
@@ -55,8 +50,11 @@ /** @defgroup Group_PipeControlReq Pipe Control Request Management
*
- * Functions, macros, variables, enums and types related to control request management of pipes.
- */
+ * Module for host mode request processing. This module allows for the transmission of standard, class and
+ * vendor control requests to the default control endpoint of an attached device while in host mode.
+ *
+ * \see Chapter 9 of the USB 2.0 specification.
+ */
#ifndef __PIPE_H__
#define __PIPE_H__
|