Fix up the incomplete Webserver project so that it integrates with the uIP stack...

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

diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index d6e5870..216d8b9 100644 (file)
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -33,14 +33,28 @@
  *  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
  *  \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
+ *        compatible terminals (any terminal codes then equate to empty strings).\r

  *\r
  *  Example Usage:\r
  *  \code\r
  *      printf("Some String, " ESC_BOLD_ON " Some bold string");\r
  *  \endcode\r
  *\r
  *  Example Usage:\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