forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More Doxygen updates for multiple architecture support.

Browse Source
pull/1469/head
Dean Camera 14 years ago
parent 5e73190582
commit 28a1ee29a1
26 changed files with 73 additions and 38 deletions
Show Stats Download Patch File Download Diff File

12
LUFA/Common/Architectures.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Supported architecture defines. * \brief Supported library architecture defines.
* *
* \copydetails Group_Architectures * \copydetails Group_Architectures
* *
@ -39,10 +39,14 @@
/** \ingroup Group_Common /** \ingroup Group_Common
* \defgroup Group_Architectures Hardware Architectures * \defgroup Group_Architectures Hardware Architectures
* \brief Supported architecture defines. * \brief Supported library architecture defines.
* *
* Macros for indicating the chosen hardware architecture to the library. These macros should be used when * Architecture macros for selecting the desired target microcontroller architecture. One of these values should be
* defining the ARCH token to the chosen hardware via the -D switch in the project makefile. * defined as the value of \c ARCH in the user project makefile via the \c -D compiler switch to GCC, to select the
* target architecture.
*
* The selected architecture should remain consistent with the makefile \c ARCH value, which is used to select the
* underlying driver source files for each architecture.
* *
* @{ * @{
*/ */

4
LUFA/Common/Attributes.h
Unescape View File

@ -41,13 +41,13 @@
* \defgroup Group_GCCAttributes Function/Variable Attributes * \defgroup Group_GCCAttributes Function/Variable Attributes
* \brief AVR-GCC special function/variable attribute macros. * \brief AVR-GCC special function/variable attribute macros.
* *
* This file contains macros for applying GCC specific attributes to functions and variables to control various * This module contains macros for applying GCC specific attributes to functions and variables to control various
* optimiser and code generation features of the compiler. Attributes may be placed in the function prototype * optimiser and code generation features of the compiler. Attributes may be placed in the function prototype
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space * or variable declaration in any order, and multiple attributes can be specified for a single item via a space
* separated list. * separated list.
* *
* On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are * On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are
* critical to the code's function and thus must throw a compiler error when used. * critical to the code's function and thus must throw a compile error when used.
* *
* @{ * @{
*/ */

9
LUFA/Common/BoardTypes.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Supported board hardware defines. * \brief Supported pre-made board hardware defines.
* *
* \copydetails Group_BoardTypes * \copydetails Group_BoardTypes
* *
@ -39,10 +39,11 @@
/** \ingroup Group_Common /** \ingroup Group_Common
* \defgroup Group_BoardTypes Board Types * \defgroup Group_BoardTypes Board Types
* \brief Supported board hardware defines. * \brief Supported pre-made board hardware defines.
* *
* Macros for indicating the chosen physical board hardware to the library. These macros should be used when * Board macros for indicating the chosen physical board hardware to the library. These macros should be used when
* defining the BOARD token to the chosen hardware via the -D switch in the project makefile. * defining the \c BOARD token to the chosen hardware via the \c -D switch in the project makefile. If a custom
* board is used, the \ref BOARD_NONE or \ref BOARD_USER values should be selected.
* *
* @{ * @{
*/ */

10
LUFA/Common/Common.h
Unescape View File

@ -29,13 +29,13 @@
*/ */
/** \file /** \file
* \brief Common library convenience macros and functions. * \brief Common library convenience headers, macros and functions.
* *
* \copydetails Group_Common * \copydetails Group_Common
*/ */
/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
* \brief Common library convenience macros and functions. * \brief Common library convenience headers, macros and functions.
* *
* Common utility headers containing macros, functions, enums and types which are common to all * Common utility headers containing macros, functions, enums and types which are common to all
* aspects of the library. * aspects of the library.
@ -44,13 +44,15 @@
*/ */
/** \defgroup Group_Debugging Debugging Macros /** \defgroup Group_Debugging Debugging Macros
* \brief Convenience macros to aid in debugging applications.
* *
* Macros for debugging use. * Macros to aid debugging of a user application.
*/ */
/** \defgroup Group_BitManip Endian and Bit Macros /** \defgroup Group_BitManip Endian and Bit Macros
* \brief Convenience macros to aid in bit manipulations and endianness transforms.
* *
* Functions for swapping endianness and reversing bit orders. * Functions for swapping endianness and reversing bit orders of data.
*/ */
#ifndef __LUFA_COMMON_H__ #ifndef __LUFA_COMMON_H__

5
LUFA/Drivers/Board/Buttons.h
Unescape View File

@ -29,10 +29,10 @@
*/ */
/** \file /** \file
* \brief Master include file for the board digital button driver. * \brief Digital button board hardware driver.
* *
* This file is the master dispatch header file for the board-specific Buttons driver, for boards containing * This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
* physical pushbuttons connected to the AVR's GPIO pins. * physical pushbuttons connected to the microcontroller's GPIO pins.
* *
* User code should include this file, which will in turn include the correct Button driver header file for the * User code should include this file, which will in turn include the correct Button driver header file for the
* currently selected board. * currently selected board.
@ -45,6 +45,7 @@
/** \ingroup Group_BoardDrivers /** \ingroup Group_BoardDrivers
* \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h * \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h
* \brief Digital button board hardware driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

6
LUFA/Drivers/Board/Dataflash.h
Unescape View File

@ -30,9 +30,10 @@
/** \file /** \file
* \brief Master include file for the board dataflash IC driver. * \brief Master include file for the board dataflash IC driver.
* \brief Atmel Dataflash storage IC board hardware driver.
* *
* This file is the master dispatch header file for the board-specific dataflash driver, for boards containing * This file is the master dispatch header file for the board-specific Atmel dataflash driver, for boards containing
* dataflash ICs for external non-volatile storage. * Atmel Dataflash ICs for external non-volatile storage.
* *
* User code should include this file, which will in turn include the correct dataflash driver header file for * User code should include this file, which will in turn include the correct dataflash driver header file for
* the currently selected board. * the currently selected board.
@ -45,6 +46,7 @@
/** \ingroup Group_BoardDrivers /** \ingroup Group_BoardDrivers
* \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h * \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
* \brief Atmel Dataflash storage IC board hardware driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

5
LUFA/Drivers/Board/Joystick.h
Unescape View File

@ -29,10 +29,10 @@
*/ */
/** \file /** \file
* \brief Master include file for the board digital joystick driver. * \brief Digital joystick board hardware driver.
* *
* This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a * This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
* 5-way joystick. * digital joystick.
* *
* User code should include this file, which will in turn include the correct joystick driver header file for the * User code should include this file, which will in turn include the correct joystick driver header file for the
* currently selected board. * currently selected board.
@ -45,6 +45,7 @@
/** \ingroup Group_BoardDrivers /** \ingroup Group_BoardDrivers
* \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h * \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h
* \brief Digital joystick board hardware driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Board/LEDs.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Master include file for the board LEDs driver. * \brief LED board hardware driver.
* *
* This file is the master dispatch header file for the board-specific LED driver, for boards containing user * This file is the master dispatch header file for the board-specific LED driver, for boards containing user
* controllable LEDs. * controllable LEDs.
@ -45,6 +45,7 @@
/** \ingroup Group_BoardDrivers /** \ingroup Group_BoardDrivers
* \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h * \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
* \brief LED board hardware driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Board/Temperature.h
Unescape View File

@ -29,13 +29,14 @@
*/ */
/** \file /** \file
* \brief Master include file for the board temperature sensor driver. * \brief NTC Temperature Sensor board hardware driver.
* *
* Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor. * Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
*/ */
/** \ingroup Group_BoardDrivers /** \ingroup Group_BoardDrivers
* \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h * \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
* \brief NTC Temperature Sensor board hardware driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Misc/RingBuffer.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Lightweight ring buffer, for fast insertion/deletion. * \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
* *
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of * Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
* different sizes to suit different needs. * different sizes to suit different needs.
@ -42,6 +42,7 @@
/** \ingroup Group_MiscDrivers /** \ingroup Group_MiscDrivers
* \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h * \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h
* \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

1
LUFA/Drivers/Misc/TerminalCodes.h
Unescape View File

@ -37,6 +37,7 @@
/** \ingroup Group_MiscDrivers /** \ingroup Group_MiscDrivers
* \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h * \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
* \brief ANSI terminal special escape code macros.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Peripheral/ADC.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Master include file for the ADC peripheral driver. * \brief Hardware Analogue-to-Digital converter driver.
* *
* This file is the master dispatch header file for the device-specific ADC driver, for microcontrollers * This file is the master dispatch header file for the device-specific ADC driver, for microcontrollers
* containing an ADC. * containing an ADC.
@ -40,6 +40,7 @@
/** \ingroup Group_PeripheralDrivers /** \ingroup Group_PeripheralDrivers
* \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h * \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h
* \brief Hardware Analogue-to-Digital converter driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Peripheral/SPI.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Master include file for the SPI peripheral driver. * \brief Hardware Serial Peripheral Interface driver.
* *
* This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers * This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
* containing a hardware SPI. * containing a hardware SPI.
@ -40,6 +40,7 @@
/** \ingroup Group_PeripheralDrivers /** \ingroup Group_PeripheralDrivers
* \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h * \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h
* \brief Hardware Serial Peripheral Interface driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Peripheral/Serial.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Master include file for the USART peripheral driver. * \brief Hardware Serial USART driver.
* *
* This file is the master dispatch header file for the device-specific USART driver, for microcontrollers * This file is the master dispatch header file for the device-specific USART driver, for microcontrollers
* containing a hardware USART. * containing a hardware USART.
@ -40,6 +40,7 @@
/** \ingroup Group_PeripheralDrivers /** \ingroup Group_PeripheralDrivers
* \defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h * \defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h
* \brief Hardware Serial USART driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

3
LUFA/Drivers/Peripheral/TWI.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Master include file for the TWI peripheral driver. * \brief Hardware Two Wire Interface (I2C) driver.
* *
* This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers * This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
* containing a hardware TWI. * containing a hardware TWI.
@ -40,6 +40,7 @@
/** \ingroup Group_PeripheralDrivers /** \ingroup Group_PeripheralDrivers
* \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h * \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h
* \brief Hardware Two Wire Interface (I2C) driver.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

1
LUFA/Drivers/USB/Class/Common/HIDParser.h
Unescape View File

@ -38,6 +38,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_HIDParser HID Report Parser * \defgroup Group_HIDParser HID Report Parser
* \brief USB Human Interface Device (HID) Class report descriptor parser.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies
* The following files must be built with any user project that uses this module: * The following files must be built with any user project that uses this module:

5
LUFA/Drivers/USB/Core/AVR8/Endpoint.h
Unescape View File

@ -38,13 +38,14 @@
/** \ingroup Group_EndpointRW /** \ingroup Group_EndpointRW
* \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8) * \defgroup Group_EndpointRW_AVR8 Endpoint Data Reading and Writing (AVR8)
* \brief USB Endpoint definitions for the AVR8 microcontrollers. * \brief Endpoint data read/write definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints. * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/ */
/** \ingroup Group_EndpointPrimitiveRW /** \ingroup Group_EndpointPrimitiveRW
* \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8) * \defgroup Group_EndpointPrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
* \brief Endpoint primative read/write definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to endpoints. * from and to endpoints.
@ -52,12 +53,14 @@
/** \ingroup Group_EndpointPacketManagement /** \ingroup Group_EndpointPacketManagement
* \defgroup Group_EndpointPacketManagement_AVR8 Endpoint Packet Management (AVR8) * \defgroup Group_EndpointPacketManagement_AVR8 Endpoint Packet Management (AVR8)
* \brief Endpoint packet management definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to packet management of endpoints. * Functions, macros, variables, enums and types related to packet management of endpoints.
*/ */
/** \ingroup Group_EndpointManagement /** \ingroup Group_EndpointManagement
* \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8) * \defgroup Group_EndpointManagement_AVR8 Endpoint Management (AVR8)
* \brief Endpoint management definitions for the Atmel AVR8 architecture.
* *
* Functions, macros and enums related to endpoint management when in USB Device mode. This * 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 * module contains the endpoint management macros, as well as endpoint interrupt and data

6
LUFA/Drivers/USB/Core/AVR8/Pipe.h
Unescape View File

@ -38,13 +38,14 @@
/** \ingroup Group_PipeRW /** \ingroup Group_PipeRW
* \defgroup Group_PipeRW_AVR8 Pipe Data Reading and Writing (AVR8) * \defgroup Group_PipeRW_AVR8 Pipe Data Reading and Writing (AVR8)
* \brief USB Pipe definitions for the AVR8 microcontrollers. * \brief Pipe data read/write definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to data reading and writing from and to pipes. * Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/ */
/** \ingroup Group_PipePrimitiveRW /** \ingroup Group_PipePrimitiveRW
* \defgroup Group_PipePrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8) * \defgroup Group_PipePrimitiveRW_AVR8 Read/Write of Primitive Data Types (AVR8)
* \brief Pipe primative data read/write definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to pipes. * from and to pipes.
@ -52,12 +53,14 @@
/** \ingroup Group_PipePacketManagement /** \ingroup Group_PipePacketManagement
* \defgroup Group_PipePacketManagement_AVR8 Pipe Packet Management (AVR8) * \defgroup Group_PipePacketManagement_AVR8 Pipe Packet Management (AVR8)
* \brief Pipe packet management definitions for the Atmel AVR8 architecture.
* *
* Functions, macros, variables, enums and types related to packet management of pipes. * Functions, macros, variables, enums and types related to packet management of pipes.
*/ */
/** \ingroup Group_PipeControlReq /** \ingroup Group_PipeControlReq
* \defgroup Group_PipeControlReq_AVR8 Pipe Control Request Management (AVR8) * \defgroup Group_PipeControlReq_AVR8 Pipe Control Request Management (AVR8)
* \brief Pipe control request management definitions for the Atmel AVR8 architecture.
* *
* Module for host mode request processing. This module allows for the transmission of standard, class and * 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. * vendor control requests to the default control endpoint of an attached device while in host mode.
@ -67,6 +70,7 @@
/** \ingroup Group_PipeManagement /** \ingroup Group_PipeManagement
* \defgroup Group_PipeManagement_AVR8 Pipe Management (AVR8) * \defgroup Group_PipeManagement_AVR8 Pipe Management (AVR8)
* \brief Pipe management definitions for the Atmel AVR8 architecture.
* *
* This module contains functions, macros and enums related to pipe management when in USB Host mode. This * 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 * module contains the pipe management macros, as well as pipe interrupt and data send/receive functions

2
LUFA/Drivers/USB/Core/Device.h
Unescape View File

@ -38,7 +38,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_Device Device Management * \defgroup Group_Device Device Management
* \brief Common USB Device definitions for all architectures. * \brief USB Device management definitions for USB device mode.
* *
* USB Device mode related definitions common to all architectures. This module contains definitions which * USB Device mode related definitions common to all architectures. This module contains definitions which
* are used when the USB controller is initialized in device mode. * are used when the USB controller is initialized in device mode.

7
LUFA/Drivers/USB/Core/Endpoint.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Common USB Endpoint definitions for all architectures. * \brief USB Endpoint definitions for all architectures.
* \copydetails Group_EndpointManagement * \copydetails Group_EndpointManagement
* *
* \note This file should not be included directly. It is automatically included as needed by the USB driver * \note This file should not be included directly. It is automatically included as needed by the USB driver
@ -38,13 +38,14 @@
/** \ingroup Group_EndpointManagement /** \ingroup Group_EndpointManagement
* \defgroup Group_EndpointRW Endpoint Data Reading and Writing * \defgroup Group_EndpointRW Endpoint Data Reading and Writing
* \brief Common USB Endpoint definitions for all architectures. * \brief Endpoint data read/write definitions.
* *
* Functions, macros, variables, enums and types related to data reading and writing from and to endpoints. * Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
*/ */
/** \ingroup Group_EndpointRW /** \ingroup Group_EndpointRW
* \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types * \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
* \brief Endpoint data primative read/write definitions.
* *
* Functions, macros, variables, enums and types related to data reading and writing of primitive data types * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to endpoints. * from and to endpoints.
@ -52,12 +53,14 @@
/** \ingroup Group_EndpointManagement /** \ingroup Group_EndpointManagement
* \defgroup Group_EndpointPacketManagement Endpoint Packet Management * \defgroup Group_EndpointPacketManagement Endpoint Packet Management
* \brief USB Endpoint package management definitions.
* *
* Functions, macros, variables, enums and types related to packet management of endpoints. * Functions, macros, variables, enums and types related to packet management of endpoints.
*/ */
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_EndpointManagement Endpoint Management * \defgroup Group_EndpointManagement Endpoint Management
* \brief Endpoint management definitions.
* *
* Functions, macros and enums related to endpoint management when in USB Device mode. This * 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 * module contains the endpoint management macros, as well as endpoint interrupt and data

2
LUFA/Drivers/USB/Core/Host.h
Unescape View File

@ -38,7 +38,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_Host Host Management * \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 * 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. * the USB controller is initialized in host mode.

2
LUFA/Drivers/USB/Core/OTG.h
Unescape View File

@ -38,7 +38,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_OTG USB On The Go (OTG) Management * \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 * 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 * exchange. OTG is a way for two USB dual role devices to talk to one another directly without fixed device/host

6
LUFA/Drivers/USB/Core/Pipe.h
Unescape View File

@ -38,13 +38,14 @@
/** \ingroup Group_PipeManagement /** \ingroup Group_PipeManagement
* \defgroup Group_PipeRW Pipe Data Reading and Writing * \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. * Functions, macros, variables, enums and types related to data reading and writing from and to pipes.
*/ */
/** \ingroup Group_PipeRW /** \ingroup Group_PipeRW
* \defgroup Group_PipePrimitiveRW Read/Write of Primitive Data Types * \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 * Functions, macros, variables, enums and types related to data reading and writing of primitive data types
* from and to pipes. * from and to pipes.
@ -52,12 +53,14 @@
/** \ingroup Group_PipeManagement /** \ingroup Group_PipeManagement
* \defgroup Group_PipePacketManagement Pipe Packet Management * \defgroup Group_PipePacketManagement Pipe Packet Management
* \brief Pipe packet management definitions.
* *
* Functions, macros, variables, enums and types related to packet management of pipes. * Functions, macros, variables, enums and types related to packet management of pipes.
*/ */
/** \ingroup Group_PipeManagement /** \ingroup Group_PipeManagement
* \defgroup Group_PipeControlReq Pipe Control Request Management * \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 * 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. * vendor control requests to the default control endpoint of an attached device while in host mode.
@ -67,6 +70,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_PipeManagement Pipe Management * \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 * 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 * module contains the pipe management macros, as well as pipe interrupt and data send/receive functions

4
LUFA/Drivers/USB/Core/StdDescriptors.h
Unescape View File

@ -29,7 +29,7 @@
*/ */
/** \file /** \file
* \brief Common USB Descriptor definitions for all architectures. * \brief Common standard USB Descriptor definitions for all architectures.
* \copydetails Group_StdDescriptors * \copydetails Group_StdDescriptors
* *
* \note This file should not be included directly. It is automatically included as needed by the USB driver * \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 /** \ingroup Group_USB
* \defgroup Group_StdDescriptors USB Descriptors * \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 * 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. * structures and macros for the easy creation of standard USB descriptors in USB device projects.

2
LUFA/Drivers/USB/Core/USBController.h
Unescape View File

@ -38,7 +38,7 @@
/** \ingroup Group_USB /** \ingroup Group_USB
* \defgroup Group_USBManagement USB Interface Management * \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. * Functions, macros, variables, enums and types related to the setup and management of the USB interface.
* *

1
LUFA/Scheduler/Scheduler.h
Unescape View File

@ -38,6 +38,7 @@
*/ */
/** \defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h /** \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. * \deprecated This module is deprecated and will be removed in a future library release.
* *

Write Preview
Loading…
Cancel
Save