X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1d433d4506113c95285f633e3553ff62d4cfd05d..d4b45e8502a27c0f5ad3e26eabd2b30e84c20bac:/LUFA/Drivers/Misc/TerminalCodes.h diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 192e4af03..5c26012ea 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2011. + Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -36,7 +36,8 @@ */ /** \ingroup Group_MiscDrivers - * @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h + * \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h + * \brief ANSI terminal special escape code macros. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: @@ -45,7 +46,7 @@ * \section Sec_ModDescription Module Description * Escape code macros for ANSI compliant text terminals. * - * \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC + * \note If desired, the macro \c DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC * compiler via the -D switch to disable the terminal codes without modifying the source, for use with non * compatible terminals (any terminal codes then equate to empty strings). * @@ -71,14 +72,14 @@ #if !defined(DISABLE_TERMINAL_CODES) /** Creates an ANSI escape sequence with the specified payload. * - * \param[in] EscapeSeq Payload to encode as an ANSI escape sequence, a ESC_* mask. + * \param[in] EscapeSeq Payload to encode as an ANSI escape sequence, a \c ESC_* mask. */ #define ANSI_ESCAPE_SEQUENCE(EscapeSeq) "\33[" EscapeSeq #else #define ANSI_ESCAPE_SEQUENCE(EscapeSeq) #endif - /** \name Text Display Modifier Escape Sequences */ + /** \name Text Display Modifier Control Sequences */ //@{ /** Turns on bold so that any following text is printed to the terminal in bold. */ #define ESC_BOLD_ON ANSI_ESCAPE_SEQUENCE("1m") @@ -114,7 +115,7 @@ */ #define ESC_STRIKETHROUGH_OFF ANSI_ESCAPE_SEQUENCE("29m") //@} - + /** \name Text Colour Control Sequences */ //@{ /** Sets the foreground (text) colour to black. */