Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.

4 files changed, 20 insertions, 18 deletions

diff --git a/LUFA/Common/Architectures.h b/LUFA/Common/Architectures.h
index 8bf9c7cac..3aa7a58d2 100644
--- a/LUFA/Common/Architectures.h
+++ b/LUFA/Common/Architectures.h
@@ -31,8 +31,7 @@
 /** \file

  *  \brief Supported architecture defines.

  *

- *  This file contains constants which can be passed to the compiler (via setting the macro ARCH) in the

- *  user project makefile using the -D option to configure the library drivers.

+ *  \copydetails Group_Architectures

  *

  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's

  *        functionality.

@@ -40,6 +39,7 @@
 

 /** \ingroup Group_Common

  *  \defgroup Group_Architectures Hardware Architectures

+ *  \brief Supported 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.

diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
index ff4058cf1..1cedaa98c 100644
--- a/LUFA/Common/Attributes.h
+++ b/LUFA/Common/Attributes.h
@@ -31,23 +31,23 @@
 /** \file
  *  \brief AVR-GCC special function/variable attribute macros.
  *
- *  This file 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.
+ *  \copydetails Group_GCCAttributes
  *
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  *        functionality.
  */
 
 /** \ingroup Group_Common
- *  \defgroup Group_GCCAttr Function/Variable Attributes
+ *  \defgroup Group_GCCAttributes Function/Variable Attributes
+ *  \brief AVR-GCC special function/variable attribute macros.
  *
- *  Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or
- *  variable attributes.
+ *  This file 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.
  *
  *  @{
  */
diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 7d9162262..9077e56f9 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -31,8 +31,7 @@
 /** \file
  *  \brief Supported board hardware defines.
  *
- *  This file contains constants which can be passed to the compiler (via setting the macro BOARD) in the
- *  user project makefile using the -D option to configure the library board-specific drivers.
+ *  \copydetails Group_BoardTypes
  *
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  *        functionality.
@@ -40,6 +39,7 @@
 
 /** \ingroup Group_Common
  *  \defgroup Group_BoardTypes Board Types
+ *  \brief Supported 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.
diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index 3afb60d00..62aee31df 100644
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -31,11 +31,11 @@
 /** \file
  *  \brief Common library convenience macros and functions.
  *
- *  This file contains macros which are common to all library elements, and which may be useful in user code. It
- *  also includes other common code headers.
+ *  \copydetails Group_Common
  */
 
 /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
+ *  \brief Common library convenience macros and functions.
  *
  *  Common utility headers containing macros, functions, enums and types which are common to all
  *  aspects of the library.
@@ -64,7 +64,8 @@
 	/* Includes: */
 		#include <stdint.h>
 		#include <stdbool.h>
-
+		#include <string.h>
+		
 		#include "Architectures.h"
 		#include "Attributes.h"
 		#include "BoardTypes.h"
@@ -75,6 +76,7 @@
 			#include <avr/interrupt.h>
 			#include <avr/pgmspace.h>
 			#include <avr/eeprom.h>
+			#include <avr/boot.h>
 			#include <util/atomic.h>
 			#include <util/delay.h>
 		#endif
@@ -123,7 +125,7 @@
 				#define MIN(x, y)               ((x < y) ? x : y)
 			#endif
 
-			#if (ARCH == ARCH_AVR8)
+			#if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__)
 				/** Defines a volatile \c NOP statement which cannot be optimized out by the compiler, and thus can always
 				 *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
 				 *  removes/reorders code to the point where break points cannot reliably be set.