X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/eee252603be67c539f9986cde76454f756e55d95..HEAD:/LUFA/Drivers/Misc/TerminalCodes.h diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 29127cf57..3ac5ac78e 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2012. + Copyright (C) Dean Camera, 2021. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2021 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 @@ -39,18 +39,18 @@ * \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 + * \section Sec_Terminal_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_Terminal_ModDescription Module Description * Escape code macros for ANSI compliant text terminals. * * \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). * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Terminal_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * @@ -80,7 +80,7 @@ #endif /** \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") @@ -93,7 +93,7 @@ /** Turns on inverse so that any following text is printed to the terminal in inverted colours. */ #define ESC_INVERSE_ON ANSI_ESCAPE_SEQUENCE("7m") - /** Turns on strikethrough so that any following text is printed to the terminal with a line through the + /** Turns on strike-through so that any following text is printed to the terminal with a line through the * center. */ #define ESC_STRIKETHROUGH_ON ANSI_ESCAPE_SEQUENCE("9m") @@ -110,14 +110,14 @@ /** Turns off inverse so that any following text is printed to the terminal in non inverted colours. */ #define ESC_INVERSE_OFF ANSI_ESCAPE_SEQUENCE("27m") - /** Turns off strikethrough so that any following text is printed to the terminal without a line through + /** Turns off strike-through so that any following text is printed to the terminal without a line through * the center. */ #define ESC_STRIKETHROUGH_OFF ANSI_ESCAPE_SEQUENCE("29m") - //@} + /**@}*/ /** \name Text Colour Control Sequences */ - //@{ + /**@{*/ /** Sets the foreground (text) colour to black. */ #define ESC_FG_BLACK ANSI_ESCAPE_SEQUENCE("30m") @@ -171,10 +171,10 @@ /** Sets the text background colour to the terminal's default. */ #define ESC_BG_DEFAULT ANSI_ESCAPE_SEQUENCE("49m") - //@} + /**@}*/ /** \name Cursor Positioning Control Sequences */ - //@{ + /**@{*/ /** 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") @@ -211,10 +211,10 @@ * \param[in] Columns Number of columns to move the cursor position */ #define ESC_CURSOR_BACKWARD(Columns) ANSI_ESCAPE_SEQUENCE(#Columns "D") - //@} + /**@}*/ /** \name Miscellaneous Control Sequences */ - //@{ + /**@{*/ /** Resets any escape sequence modifiers back to their defaults. */ #define ESC_RESET ANSI_ESCAPE_SEQUENCE("0m") @@ -223,7 +223,7 @@ /** Erases the current line, returning the cursor to the far left. */ #define ESC_ERASE_LINE ANSI_ESCAPE_SEQUENCE("K") - //@} + /**@}*/ #endif