X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/e426463355b8516a442c01e0e6b4a574c39fc0f4..eaa914a4e445c25ffdbee7be7caf85165540c98a:/LUFA/ManPages/CompileTimeTokens.txt

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 513d85454..8213c678b 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -23,17 +23,6 @@
  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens
  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.
  *
- *  <b>HID_ENABLE_FEATURE_PROCESSING</b> - ( \ref Group_HIDParser ) \n
- *  Define this token to enable the processing of FEATURE HID report items, if any, into the processed HID structure.
- *  By default FEATURE items (which are device features settable by the host but not directly visible by the user) are
- *  skipped when processing a device HID report.
- *
- *  <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - ( \ref Group_HIDParser ) \n
- *  By default, constant data items (usually used as spacers to align separate report items to a byte or word boundary)
- *  in the HID report are skipped during report processing. It is highly unusual for an application to make any use of
- *  constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining
- *  this switch will put constant data items into the processed HID report structure.
- *
  *  <b>HID_STATETABLE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n
  *  HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This
  *  allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous
@@ -62,6 +51,13 @@
  *  If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the
  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
  *
+ *  <b>HID_MAX_REPORT_IDS</b> - ( \ref Group_HIDParser ) \n
+ *  HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination
+ *  keyboard and mouse might use report IDs to seperate the keyboard reports from the mouse reports. In order to determine the size of each
+ *  report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and
+ *  stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed
+ *  and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in
+ *  the HID.h file documentation.
  *
  *  \section Sec_SummaryUSBTokens USB Driver Related Tokens
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
@@ -76,12 +72,6 @@
  *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
  *
- *  <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - ( \ref Group_Descriptors ) \n
- *  The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,
- *  string, endpoint, etc.). By default the LUFA library uses these names in its predefined descriptor structure types for
- *  compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive
- *  names documented in the StdDescriptors.h source file.
- *
  *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
  *  Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This
  *  allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing
@@ -109,7 +99,7 @@
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
  *  implicitly via the library APIs.
  *
- *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n
+ *  <b>FIXED_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n
  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
  *  the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
  *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project
@@ -172,8 +162,8 @@
  *  VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
  *  slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
  *  required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global
- *  can be accurately set and the USB_Connect and USB_Disconnect events manually raised by the RAISE_EVENT macro. When defined, this token disables
- *  the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
+ *  can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
+ *  When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
  *
  *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
  *  Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly.