Better documentation for the ANSI terminal escape codes header.

Organise the current version changelog better to group core and non-core changes together.

LUFA/Drivers/Misc/TerminalCodes.h

@@ -63,13 +63,13 @@
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			#if !defined(DISABLE_TERMINAL_CODES)
-				/** Creates an ANSI escape sequence with the payload specified by "c".
+				/** Creates an ANSI escape sequence with the specified payload.
 				 *
-				 *  \param[in] c  Payload to encode as an ANSI escape sequence, a ESC_* mask.
+				 *  \param[in] EscapeSeq  Payload to encode as an ANSI escape sequence, a ESC_* mask.
 				 */
-				#define ANSI_ESCAPE_SEQUENCE(c)  "\33[" c
+				#define ANSI_ESCAPE_SEQUENCE(EscapeSeq)  "\33[" EscapeSeq
 			#else
-				#define ANSI_ESCAPE_SEQUENCE(c)
+				#define ANSI_ESCAPE_SEQUENCE(EscapeSeq)
 			#endif
 
 			/** \name Text Display Modifier Escape Sequences */
@@ -168,26 +168,42 @@
 
 			/** \name Cursor Positioning Control Sequences */
 			//@{
-			/** Sets the cursor position to the given line and column. */
+			/** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */
-			#define ESC_CURSOR_POS(L, C)     ANSI_ESCAPE_SEQUENCE(#L ";" #C "H")
+			#define ESC_CURSOR_POS_SAVE             ANSI_ESCAPE_SEQUENCE("s")
 
-			/** Moves the cursor up the given number of lines. */
+			/** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
-			#define ESC_CURSOR_UP(L)         ANSI_ESCAPE_SEQUENCE(#L "A")
+			#define ESC_CURSOR_POS_RESTORE          ANSI_ESCAPE_SEQUENCE("u")
 
-			/** Moves the cursor down the given number of lines. */
+			/** Sets the cursor position to the given line and column.
-			#define ESC_CURSOR_DOWN(L)       ANSI_ESCAPE_SEQUENCE(#L "B")
+			 *
+			 *  \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")
 
-			/** Moves the cursor to the right the given number of columns. */
+			/** Moves the cursor up the given number of lines.
-			#define ESC_CURSOR_FORWARD(C)    ANSI_ESCAPE_SEQUENCE(#C "C")
+			 *
+			 *  \param[in] Lines  Number of lines to move the cursor position
+			 */
+			#define ESC_CURSOR_UP(Lines)            ANSI_ESCAPE_SEQUENCE(#Lines "A")
 
-			/** Moves the cursor to the left the given number of columns. */
+			/** Moves the cursor down the given number of lines.
-			#define ESC_CURSOR_BACKWARD(C)   ANSI_ESCAPE_SEQUENCE(#C "D")
+			 *
+			 *  \param[in] Lines  Number of lines to move the cursor position
+			 */
+			#define ESC_CURSOR_DOWN(Lines)          ANSI_ESCAPE_SEQUENCE(#Lines "B")
 
-			/** Saves the current cursor position so that it may be restored with \ref ESC_CURSOR_POS_RESTORE. */
+			/** Moves the cursor to the right the given number of columns.
-			#define ESC_CURSOR_POS_SAVE      ANSI_ESCAPE_SEQUENCE("s")
+			 *
+			 *  \param[in] Columns  Number of columns to move the cursor position
+			 */
+			#define ESC_CURSOR_FORWARD(Columns)     ANSI_ESCAPE_SEQUENCE(#Columns "C")
 
-			/** Restores the cursor position to the last position saved with \ref ESC_CURSOR_POS_SAVE. */
+			/** Moves the cursor to the left the given number of columns.
-			#define ESC_CURSOR_POS_RESTORE   ANSI_ESCAPE_SEQUENCE("u")
+			 *
+			 *  \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 */

LUFA/ManPages/ChangeLog.txt

@@ -8,6 +8,7 @@
   *
   *  \section Sec_ChangeLogXXXXXX Version XXXXXX
   *  <b>New:</b>
+  *  - Core:
   *    - Added new SCSI_ASENSE_NOT_READY_TO_READY_CHANGE constant to the Mass Storage class driver, to indicate when a previously
   *      not ready removable medium has now become ready for the host's use (thanks to Martin Degelsegger)
   *    - Moved the Pipe and Endpoint stream related code to two new USB library core source files EndpointStream.c and PipeStream.c
@@ -28,19 +29,35 @@
   *    - Added board hardware driver support for the Maximus board (thanks to the PSGroove team)
   *    - Added board hardware driver support for the Minimus board (thanks to the PSGroove team)
   *    - Added board hardware driver support for the Adafruit U4 breakout board
-  *  - Added default test tone generation mode to the Device mode AudioInput demos
   *    - Added new NO_CLASS_DRIVER_AUTOFLUSH compile time option to disable automatic flushing of interfaces when the USB management
   *      tasks for each driver is called
   *    - Added standard keyboard HID report scancode defines (thanks to Laszlo Monda)
   *    - Added new Pipe_GetBusyBanks(), Endpoint_GetBusyBanks() and Endpoint_AbortPendingIN() functions
+  *  - Library Applications:
+  *    - Added default test tone generation mode to the Device mode AudioInput demos
   *    - Added new NO_BLOCK_SUPPORT, NO_EEPROM_BYTE_SUPPORT, NO_FLASH_BYTE_SUPPORT and NO_LOCK_BYTE_WRITE_SUPPORT compile time options to the
   *      CDC class bootloader
   *    - Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone programmer project (thanks to Tom Light)
   *
   *  <b>Changed:</b>
+  *  - Core:
   *    - Removed complicated logic for the Endpoint_ConfigureEndpoint() function to use inlined or function called versions
   *      depending of if the given bank size is a compile time constant, as the compiler does a better job of optimizing
   *      with basic code
+  *    - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
+  *      the need for extra casting inside the callback (thanks to Jonathan Kollasch)
+  *    - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
+  *    - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
+  *    - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
+  *    - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another
+  *    - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for
+  *      the given endpoint
+  *    - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present)
+  *    - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be seperately included
+  *    - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called
+  *    - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library
+  *      request handlers, not afterwards
+  *  - Library Applications:
   *    - Changed over all device demos to use a clearer algorithm for the configuring of the application's endpoints
   *    - Added missing DataflashManager_CheckDataflashOperation() function to the MassStorageKeyboard demo, removed redundant
   *      SCSI_Codes.h file as these values are part of the MassStorage Class Driver
@@ -49,56 +66,45 @@
   *    - Changed all Device mode LowLevel demos and Device Class drivers so that the control request is acknowledged and any data
   *      transferred as quickly as possible without any processing inbetween sections, so that long callbacks or event handlers will
   *      not break communications with the host by exceeding the maximum control request stage timeout period
-  *  - Changed the signature of the CALLBACK_USB_GetDescriptor() callback function so that the descriptor pointer is const, to remove
-  *    the need for extra casting inside the callback (thanks to Jonathan Kollasch)
-  *  - Reduced HOST_DEVICE_SETTLE_DELAY_MS to 1000ms down from 1500ms to improve device compatibility while in USB Host mode
   *    - Changed over all demos, drivers and internal functions to use the current frame number over the Start of Frame flag where possible
   *      to free up the Start of Frame flag for interrupt use in the user application
   *    - All project makefiles now correctly clean intermediate build files from assembly and C++ sources (thanks to Daniel Czigany)
-  *  - Removed the EVENT_USB_InitFailure() event, not specifying a USB mode correctly now defaults to UID selection mode
-  *  - Renamed and moved class driver common constant definitions to make the naming scheme more uniform
   *    - Changed default value for the reset polarity parameter in the AVRISP-MKII project so that it defaults to active low drive
   *    - Changed configuration descriptor parser for all host mode projects and class drivers to ensure better compatibility with devices
-  *  - Moved the USB mode specifier constants into a new enum, so that they are semantically related to one another
-  *  - Renamed ENDPOINT_DOUBLEBANK_SUPPORTED() to ENDPOINT_BANKS_SUPPORTED() and changed it to return the maximum number of supported banks for
-  *    the given endpoint
-  *  - Better algorithm to extract and convert the internal device serial number into a string descriptor (if present)
-  *  - All USB class drivers are now automatically included when LUFA/Drivers/USB.h is included, and no longer need to be seperately included
   *    - All LowLevel demos changed to use the constants and types defined in the USB class drivers
   *    - Changed AudioInput and AudioOutput demos to reload the next sample via an interrupt rather than polling the sample timer
-  *  - The MIDI class drivers now automatically flushes the MIDI interface when the MIDI class driver's USBTask() function is called
   *    - Rescue clock of the AVRISP-MKII moved to the AVR's OCR1A pin, so that the clock can be generated at all times
   *    - Changed ClassDriver MIDI demos to process all incomming events in a loop until the bank becomes empty rather than one at a time
   *    - Changed LowLevel MIDI demos to only clear the incomming event bank once it has become empty to support packed event packets
-  *  - Renamed the EVENT_USB_Device_UnhandledControlRequest() event to EVENT_USB_Device_ControlRequest() as it is now fired before the library
-  *    request handlers, not afterwards
   *
   *  <b>Fixed:</b>
+  *  - Core:
   *    - Fixed USB_GetHIDReportItemInfo() function modifying the given report item's data when the report item does not exist
   *      within the supplied report of a multiple report HID device
-  *  - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
-  *    missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
   *    - Fixed critical pipe/endpoint memory allocation issue where the bank memory address space could be silently overlapped
   *      in the USB controller if the endpoints or pipes were allocated in anything other than ascending order (thanks to Martin Degelsegger)
-  *  - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
-  *    request handler
-  *  - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
   *    - Added LEDs_ToggleLEDs() function to several board LED drivers which were missing it (thanks to Andrei Krainev)
   *    - Fixed SET FEATURE and CLEAR FEATURE control requests directed at an unconfigured endpoint causing request timeouts
-  *  - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
   *    - Fixed USB_Host_ClearPipeStall() incorrectly determining the endpoint direction from the currently selected pipe
   *    - Fixed JTAG_DEBUG_POINT() and JTAG_DEBUG_BREAK() macros not compiling under pure C99 standards mode
   *    - Fixed endpoint selection within the CALLBACK_HID_Device_CreateHIDReport() callback function causing broken GET REPORT requests
   *    - Fixed incorrect command name for EEPROM memory programming in the makefile dfu-ee target
-  *  - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
   *    - Fixed incorrect LEDs_ChangeLEDs() function in the Benito board LED driver
   *    - Fixed incorrect USB_DeviceState value when unconfiguring the device without an address set
-  *  - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
   *    - Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init() is called
-  *  - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
   *    - Fixed random enumeration failure while in device mode due to interrupts causing the Set Address request to exceed maximum timings
   *    - Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured
   *    - Fixed MIDI class driver send routines silently discarding packets if the endpoint or pipe is busy (thanks to Robin Green)
+  *  - Library Applications:
+  *    - Fixed MassStorage based demos and projects resetting the SCSI sense values before the command is executed, leading to
+  *      missed SCSI sense values when the host retrieves the sense key (thanks to Martin Degelsegger)
+  *    - Fixed USBtoSerial and Benito project SetLineEncoding calls failing if the USART is busy, due to the RX ISR delaying the control
+  *      request handler
+  *    - Fixed LowLevel PrinterHost demo not sending control requests to the attached printer with the correct printer interface wIndex value
+  *    - Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2
+  *    - Fixed BootloaderCDC project failing on some operating systems due to removed Line Encoding options (thanks to Alexey Belyaev)
+  *    - Fixed broken FLASH/EEPROM programming in the AVRISP-MKII clone project when writing in non-paged mode and the polling byte cannot be used
+  *    - Fixed ISR definition conflict in the XPLAIN bridge between the software UART and the AVRISP-MKII ISP modules
   *    - Fixed USBtoSerial and XPLAINBridge demos discarding data from the PC if the send buffer becomes full
   *    - Fixed broken input in the MagStripe reader project due to an incorrect HID report descriptor
   *    - Fixed incorrect PollingIntervalMS values in the demo/project/bootloader endpoint descriptors (thanks to MCS Electronics)