michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More documentation changes for better module-level documentation rather than file-level documentation.

Browse Source
This commit is contained in:
Dean Camera
2009-04-17 05:04:21 +00:00
parent 6380d057f8
commit d38fa49cb6
61 changed files with 414 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LUFA/Drivers/USB/LowLevel/DevChapter9.h
-8
View File
@@ -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__
LUFA/Drivers/USB/LowLevel/Device.h
+2 -7
View File
@@ -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.
*
* @{
*/
LUFA/Drivers/USB/LowLevel/Endpoint.h
+2 -7
View File
@@ -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.
*
* @{
*/
LUFA/Drivers/USB/LowLevel/Host.h
+2 -7
View File
@@ -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.
*
* @{
*/
LUFA/Drivers/USB/LowLevel/HostChapter9.h
-8
View File
@@ -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__
LUFA/Drivers/USB/LowLevel/LowLevel.h
-6
View File
@@ -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
*
LUFA/Drivers/USB/LowLevel/OTG.h
+3 -9
View File
@@ -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.
*
* @{
*/
LUFA/Drivers/USB/LowLevel/Pipe.h
+8 -10
View File
@@ -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__