Commit 28a1ee29 authored by Dean Camera's avatar Dean Camera
Browse files

More Doxygen updates for multiple architecture support.

parent 5e731905
......@@ -38,7 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_Host Host Management
* \brief Common USB Host definitions for all architectures.
* \brief USB Host management definitions for USB 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.
......
......@@ -38,7 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_OTG USB On The Go (OTG) Management
* \brief Common USB OTG definitions for all architectures.
* \brief USB OTG management definitions.
*
* 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
......
......@@ -38,13 +38,14 @@
/** \ingroup Group_PipeManagement
* \defgroup Group_PipeRW Pipe Data Reading and Writing
* \brief Common USB Pipe definitions for all architectures.
* \brief Pipe data read/write definitions.
*
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/
/** \ingroup Group_PipeRW
* \defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types
* \brief Pipe data primative read/write definitions.
*
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to pipes.
......@@ -52,12 +53,14 @@
/** \ingroup Group_PipeManagement
* \defgroup Group_PipePacketManagement Pipe Packet Management
* \brief Pipe packet management definitions.
*
* Functions, macros, variables, enums and types related to packet management of pipes.
*/
/** \ingroup Group_PipeManagement
* \defgroup Group_PipeControlReq Pipe Control Request Management
* \brief Pipe control request definitions.
*
* 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.
......@@ -67,6 +70,7 @@
/** \ingroup Group_USB
* \defgroup Group_PipeManagement Pipe Management
* \brief Pipe management definitions.
*
* 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/receive functions
......
......@@ -29,7 +29,7 @@
*/
/** \file
* \brief Common USB Descriptor definitions for all architectures.
* \brief Common standard USB Descriptor definitions for all architectures.
* \copydetails Group_StdDescriptors
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
......@@ -38,7 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_StdDescriptors USB Descriptors
* \brief Common USB Descriptor definitions for all architectures.
* \brief Standard USB Descriptor definitions.
*
* Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains
* structures and macros for the easy creation of standard USB descriptors in USB device projects.
......
......@@ -38,7 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_USBManagement USB Interface Management
* \brief Common USB Controller definitions for all architectures.
* \brief USB Controller definitions for general USB controller management.
*
* Functions, macros, variables, enums and types related to the setup and management of the USB interface.
*
......
......@@ -38,6 +38,7 @@
*/
/** \defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h
* \brief Simple round-robbin pseudo-task scheduler.
*
* \deprecated This module is deprecated and will be removed in a future library release.
*
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment