X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/8f6b4ddf764c3a54e42d00a7502c82c5c3e71b1c..b2330934b9ccd51a59183eb2a11fdd95183df27b:/LUFA/Drivers/Misc/TerminalCodes.h diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 1206ade26..11dcc03cb 100644 --- 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 * 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 + * + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - None + * + * \section 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 * compiler via the -D switch to disable the terminal codes without modifying the source, for use with non * compatible terminals (any terminal code then equate to empty strings). @@ -41,12 +53,6 @@ * \code * printf("Some String, " ESC_BOLD_ON " Some bold string"); * \endcode - */ - -/** \ingroup Group_MiscDrivers - * @defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h - * - * Escape code macros for ANSI compliant text terminals. * * @{ */ @@ -169,10 +175,10 @@ /** Moves the cursor to the left the given number of columns. */ #define ESC_CURSOR_BACKWARD(C) ANSI_ESCAPE_SEQUENCE(#C "D") - /** Saves the current cursor position so that it may be restored with ESC_CURSOR_POS_RESTORE. */ + /** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */ #define ESC_CURSOR_POS_SAVE ANSI_ESCAPE_SEQUENCE("s") - /** Restores the cursor position to the last position saved with ESC_CURSOR_POS_SAVE. */ + /** 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. */