X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/8f981b5f38b22f1a49fdec9ff5d09ac982cd71f3..a49b5bfd8a1dce6276ff5dac1bddfe43d6ad73ab:/LUFA/Drivers/Misc/TerminalCodes.h?ds=sidebyside diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index f6673bc81..192e4af03 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 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 @@ -42,16 +42,22 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \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 * 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). * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code - * printf("Some String, " ESC_BOLD_ON " Some bold string"); + * printf("Normal String, " + * ESC_BOLD_ON "Bold String, " + * ESC_UNDERLINE_ON "Bold and Underlined String" + * ESC_RESET ESC_FG_BLUE ESC_BG_YELLOW "Normal Blue-on-Yellow String"); * \endcode * * @{ @@ -176,8 +182,8 @@ /** Sets the cursor position to the given line and column. * - * \param[in] Line Line number to position the cursor at - * \param[in] Column Column number to position the cursor at + * \param[in] Line Line number to position the cursor at. + * \param[in] Column Column number to position the cursor at. */ #define ESC_CURSOR_POS(Line, Column) ANSI_ESCAPE_SEQUENCE(#Line ";" #Column "H")