Add new incomplete HIDReportViewer project.
[pub/lufa.git] / LUFA / ManPages / CompileTimeTokens.txt
index 415fde5..2d067ba 100644 (file)
@@ -10,9 +10,9 @@
  *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
  *  or remove features unused by a given application in order to save flash space.
  *
- *  If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located
- *  in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile
- *  defined tokens for configuring the library.
+ *  \note If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located
+ *        in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile
+ *        defined tokens for configuring the library.
  *
  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens
  *  This section describes compile tokens which affect non-USB sections of the LUFA library.
  *
  *  <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement)  - <i>AVR8 Only</i> \n
  *  The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> be configured in an ascending order to
- *  prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialisation. This compile
- *  time token may be used to restrict the intialisation order to ascending indexes only in exchange for a smaller compiled binary size.
+ *  prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialization. This compile
+ *  time token may be used to restrict the initialization order to ascending indexes only in exchange for a smaller compiled binary size. Use
+ *  caution when applied to applications using the library USB Class drivers; the user application must ensure that all endpoints and pipes are
+ *  allocated sequentially.
  *
  *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - (\ref Group_USBManagement) - <i>All Architectures</i> \n
  *  By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad