Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed...

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

diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h
index 0576285..5048e21 100644 (file)
--- a/LUFA/Drivers/Misc/TerminalCodes.h
+++ b/LUFA/Drivers/Misc/TerminalCodes.h
@@ -1,7 +1,7 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

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


@@ -9,13 +9,13 @@
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

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


@@ -34,7 +34,7 @@
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing
  *  strings to modify their display on a compatible terminal application.
  */
  *  ANSI terminal compatible escape sequences. These escape sequences are designed to be concatenated with existing
  *  strings to modify their display on a compatible terminal application.
  */

- 
+

 /** \ingroup Group_MiscDrivers
  *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
  *
 /** \ingroup Group_MiscDrivers
  *  @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h
  *


@@ -56,14 +56,17 @@
  *
  *  @{
  */
  *
  *  @{
  */

- 
+

 #ifndef __TERMINALCODES_H__
 #define __TERMINALCODES_H__
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        #if !defined(DISABLE_TERMINAL_CODES)
 #ifndef __TERMINALCODES_H__
 #define __TERMINALCODES_H__
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        #if !defined(DISABLE_TERMINAL_CODES)

-                               /** Creates an ANSII escape sequence with the payload specified by "c". */
+                               /** Creates an ANSI escape sequence with the payload specified by "c".
+                                *
+                                *  \param[in] c  Payload to encode as an ANSI escape sequence, a ESC_* mask.
+                                */

                                #define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c
                        #else
                                #define ANSI_ESCAPE_SEQUENCE(c)
                                #define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c
                        #else
                                #define ANSI_ESCAPE_SEQUENCE(c)


@@ -94,8 +97,8 @@
 
                        /** Turns off italics so that any following text is printed to the terminal in non italics. */
                        #define ESC_ITALICS_OFF          ANSI_ESCAPE_SEQUENCE("23m")
 
                        /** Turns off italics so that any following text is printed to the terminal in non italics. */
                        #define ESC_ITALICS_OFF          ANSI_ESCAPE_SEQUENCE("23m")

-                       
-                       /** Turns off underline so that any following text is printed to the terminal non underlined. */                        
+
+                       /** Turns off underline so that any following text is printed to the terminal non underlined. */

                        #define ESC_UNDERLINE_OFF        ANSI_ESCAPE_SEQUENCE("24m")
 
                        /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */
                        #define ESC_UNDERLINE_OFF        ANSI_ESCAPE_SEQUENCE("24m")
 
                        /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */


@@ -159,7 +162,7 @@
 
                        /** Sets the text background colour to the terminal's default. */
                        #define ESC_BG_DEFAULT           ANSI_ESCAPE_SEQUENCE("49m")
 
                        /** Sets the text background colour to the terminal's default. */
                        #define ESC_BG_DEFAULT           ANSI_ESCAPE_SEQUENCE("49m")

-                       
+

                        /** Sets the cursor position to the given line and column. */
                        #define ESC_CURSOR_POS(L, C)     ANSI_ESCAPE_SEQUENCE(#L ";" #C "H")
 
                        /** Sets the cursor position to the given line and column. */
                        #define ESC_CURSOR_POS(L, C)     ANSI_ESCAPE_SEQUENCE(#L ";" #C "H")
 


@@ -180,7 +183,7 @@
 
                        /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
                        #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")
 
                        /** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
                        #define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")

-                       
+

                        /** Erases the entire display, returning the cursor to the top left. */
                        #define ESC_ERASE_DISPLAY        ANSI_ESCAPE_SEQUENCE("2J")
 
                        /** Erases the entire display, returning the cursor to the top left. */
                        #define ESC_ERASE_DISPLAY        ANSI_ESCAPE_SEQUENCE("2J")
 


@@ -190,3 +193,4 @@
 #endif
 
 /** @} */
 #endif
 
 /** @} */

+