ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More Doxygen updates for multiple architecture support.

Browse source
This commit is contained in:
Dean Camera 2011-02-20 14:07:20 +00:00
parent 5e73190582
commit 28a1ee29a1
26 changed files with 73 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

12
LUFA/Common/Architectures.h
View file

@ -29,7 +29,7 @@
*/
/** \file
* \brief Supported architecture defines.
* \brief Supported library architecture defines.
*
* \copydetails Group_Architectures
*
@ -39,10 +39,14 @@
/** \ingroup Group_Common
* \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
* defining the ARCH token to the chosen hardware via the -D switch in the project makefile.
* Architecture macros for selecting the desired target microcontroller architecture. One of these values should be
* 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
View file

@ -41,13 +41,13 @@
* \defgroup Group_GCCAttributes Function/Variable Attributes
* \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
* or variable declaration in any order, and multiple attributes can be specified for a single item via a space
* separated list.
*
* 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
View file

@ -29,7 +29,7 @@
*/
/** \file
* \brief Supported board hardware defines.
* \brief Supported pre-made board hardware defines.
*
* \copydetails Group_BoardTypes
*
@ -39,10 +39,11 @@
/** \ingroup Group_Common
* \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
* defining the BOARD token to the chosen hardware via the -D switch in the project makefile.
* Board macros for indicating the chosen physical board hardware to the library. These macros should be used when
* 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
View file

@ -29,13 +29,13 @@
*/
/** \file
* \brief Common library convenience macros and functions.
* \brief Common library convenience headers, macros and functions.
*
* \copydetails Group_Common
*/
/** \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
* aspects of the library.
@ -44,13 +44,15 @@
*/
/** \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
* \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__