aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Common
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-02-20 14:07:20 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-02-20 14:07:20 +0000
commit28a1ee29a1a200c8e8c76355a9036a7456425bc3 (patch)
treef388464eba14f094c79b0597aec4277356f8455a /LUFA/Common
parent5e7319058268e021ae39ca4b9fcabaec0060117b (diff)
downloadlufa-28a1ee29a1a200c8e8c76355a9036a7456425bc3.tar.gz
lufa-28a1ee29a1a200c8e8c76355a9036a7456425bc3.tar.bz2
lufa-28a1ee29a1a200c8e8c76355a9036a7456425bc3.zip
More Doxygen updates for multiple architecture support.
Diffstat (limited to 'LUFA/Common')
-rw-r--r--LUFA/Common/Architectures.h12
-rw-r--r--LUFA/Common/Attributes.h4
-rw-r--r--LUFA/Common/BoardTypes.h9
-rw-r--r--LUFA/Common/Common.h10
4 files changed, 21 insertions, 14 deletions
diff --git a/LUFA/Common/Architectures.h b/LUFA/Common/Architectures.h
index 3aa7a58d2..85f0d39bd 100644
--- a/LUFA/Common/Architectures.h
+++ b/LUFA/Common/Architectures.h
@@ -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.
*
* @{
*/
diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
index 1cedaa98c..ad6882769 100644
--- a/LUFA/Common/Attributes.h
+++ b/LUFA/Common/Attributes.h
@@ -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.
*
* @{
*/
diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 9077e56f9..41dc490e1 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -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.
*
* @{
*/
diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index 62aee31df..57bebeda4 100644
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -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__