Minor documentation improvements.

3 files changed, 14 insertions, 14 deletions

diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
index 07852813a..67a3166b2 100644
--- a/LUFA/Common/Attributes.h
+++ b/LUFA/Common/Attributes.h
@@ -73,9 +73,9 @@
 				 */
 				#define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))
 
-				/** Indicates that the specified parameters of the function are pointers which should never be NULL.
+				/** Indicates that the specified parameters of the function are pointers which should never be \c NULL.
 				 *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified
-				 *  parameters are known at compiler time to be NULL at the point of calling the function.
+				 *  parameters are known at compiler time to be \c NULL at the point of calling the function.
 				 */
 				#define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))
 
diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
index 9f9c1a8bc..d76e318f6 100644
--- a/LUFA/Common/BoardTypes.h
+++ b/LUFA/Common/BoardTypes.h
@@ -73,8 +73,8 @@
 			#define BOARD_ATAVRUSBRF01  4
 
 			/** Selects the user-defined board drivers, which should be placed in the user project's folder
-			 *  under a directory named /Board/. Each board driver should be named identically to the LUFA
-			 *  master board driver (i.e., driver in the LUFA/Drivers/Board director) so that the library
+			 *  under a directory named \c /Board/. Each board driver should be named identically to the LUFA
+			 *  master board driver (i.e., driver in the \c LUFA/Drivers/Board directory) so that the library
 			 *  can correctly identify it.
 			 */
 			#define BOARD_USER          5
diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index 8e7f2398a..837cb0475 100644
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -32,7 +32,7 @@
  *  \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 headers, such as Atomic.h, Attributes.h and BoardTypes.h.
+ *  also includes other common code headers.
  */
 
 /** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h
@@ -68,18 +68,18 @@
 			/** Macro for encasing other multi-statement macros. This should be used along with an opening brace
 			 *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
 			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
-			 *  a block (such as inline IF statements).
+			 *  a block (such as inline \c if statements).
 			 */
 			#define MACROS                  do
 
 			/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing
 			 *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated
 			 *  as a discrete block and not as a list of separate statements which may cause problems when used as
-			 *  a block (such as inline IF statements).
+			 *  a block (such as inline \c if statements).
 			 */
 			#define MACROE                  while (0)
 
-			/** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
+			/** 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.
 			 *
@@ -87,14 +87,14 @@
 			 */
 			#define JTAG_DEBUG_POINT()      __asm__ __volatile__ ("NOP" ::)
 
-			/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When
+			/** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When
 			 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.
 			 *
 			 *  \ingroup Group_Debugging
 			 */
 			#define JTAG_DEBUG_BREAK()      __asm__ __volatile__ ("BREAK" ::)
 
-			/** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.
+			/** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false.
 			 *
 			 *  \param[in] Condition  Condition that will be evaluated,
 			 *
@@ -102,7 +102,7 @@
 			*/
 			#define JTAG_DEBUG_ASSERT(Condition)    MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE
 
-			/** Macro for testing condition "x" and writing debug data to the stdout stream if false. The stdout stream
+			/** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream
 			 *  must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART
 			 *  peripheral.
 			 *
@@ -118,7 +118,7 @@
 			
 			/** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given
 			 *  struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through
-			 *  a pointer, resulting in a larger binary. When this macro is used on a (non-const) structure pointer before
+			 *  a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before
 			 *  use, it will force GCC to use pointer indirection on the elements rather than direct store and load
 			 *  instructions.
 			 *
@@ -127,8 +127,8 @@
 			#define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
 
 			#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
-				/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr()
-				 *  macro with a void* cast, so that its value can be assigned directly to a pointer variable or used
+				/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc \c pgm_read_ptr()
+				 *  macro with a \c void* cast, so that its value can be assigned directly to a pointer variable or used
 				 *  in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be
 				 *  part of the standard API and will be implemented in a more formal manner.
 				 *