Some minor whitespace corrections.

[pub/USBasp.git] / LUFA / Drivers / Misc / TerminalCodes.h

diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index d6e5870..11dcc03 100644 (file)
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -33,6 +33,18 @@
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing\r
  *  strings to modify their display on a compatible terminal application.\r
  *\r
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing\r
  *  strings to modify their display on a compatible terminal application.\r
  *\r

+ */\r
+ \r
+/** \ingroup Group_MiscDrivers\r
+ *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - None\r
+ *\r
+ *  \section Module Description\r
+ *  Escape code macros for ANSI compliant text terminals.\r
+ *\r

  *  \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC\r
  *        compiler via the -D switch to disable the terminal codes without modifying the source, for use with non\r
  *        compatible terminals (any terminal code then equate to empty strings).\r
  *  \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC\r
  *        compiler via the -D switch to disable the terminal codes without modifying the source, for use with non\r
  *        compatible terminals (any terminal code then equate to empty strings).\r


@@ -41,6 +53,8 @@
  *  \code\r
  *      printf("Some String, " ESC_BOLD_ON " Some bold string");\r
  *  \endcode\r
  *  \code\r
  *      printf("Some String, " ESC_BOLD_ON " Some bold string");\r
  *  \endcode\r

+ *\r
+ *  @{\r

  */\r
  \r
 #ifndef __TERMINALCODES_H__\r
  */\r
  \r
 #ifndef __TERMINALCODES_H__\r


@@ -161,10 +175,10 @@
                        /** Moves the cursor to the left the given number of columns. */\r
                        #define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")\r
 \r
                        /** Moves the cursor to the left the given number of columns. */\r
                        #define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")\r
 \r

-                       /** Saves the current cursor position so that it may be restored with ESC_CURSOR_POS_RESTORE. */\r
+                       /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */\r

                        #define ESC_CURSOR_POS_SAVE      ANSI_ESCAPE_SEQUENCE("s")\r
 \r
                        #define ESC_CURSOR_POS_SAVE      ANSI_ESCAPE_SEQUENCE("s")\r
 \r

-                       /** Restores the cursor position to the last position saved with ESC_CURSOR_POS_SAVE. */\r
+                       /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */\r

                        #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")\r
                        \r
                        /** Erases the entire display, returning the cursor to the top left. */\r
                        #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")\r
                        \r
                        /** Erases the entire display, returning the cursor to the top left. */\r


@@ -174,3 +188,5 @@
                        #define ESC_ERASE_LINE           ANSI_ESCAPE_SEQUENCE("K")\r
 \r
 #endif\r
                        #define ESC_ERASE_LINE           ANSI_ESCAPE_SEQUENCE("K")\r
 \r
 #endif\r

+\r
+/** @} */\r