Added new Pipe_BoundEndpointNumber() and Pipe_IsEndpointBound() functions.

[pub/lufa.git] / LUFA / ManPages / ConfiguringApps.txt

diff --git a/LUFA/ManPages/ConfiguringApps.txt b/LUFA/ManPages/ConfiguringApps.txt
index bb6d185..fb9da70 100644 (file)
--- a/LUFA/ManPages/ConfiguringApps.txt
+++ b/LUFA/ManPages/ConfiguringApps.txt
@@ -24,7 +24,9 @@
  *    - <b>BOARD</b>, the target board hardware\r
  *    - <b>F_CLOCK</b>, the target raw master clock frequency, before any prescaling is performed\r
  *    - <b>F_CPU</b>, the target AVR CPU master clock frequency, after any prescaling\r
  *    - <b>BOARD</b>, the target board hardware\r
  *    - <b>F_CLOCK</b>, the target raw master clock frequency, before any prescaling is performed\r
  *    - <b>F_CPU</b>, the target AVR CPU master clock frequency, after any prescaling\r

- *    - <b>CDEFS</b>, the C preprocessor defines which configure the source code\r
+ *    - <b>CDEFS</b>, the C preprocessor defines which configure options the source code\r
+ *    - <b>LUFA_PATH</b>, the path to the LUFA library source code\r
+ *    - <b>LUFA_OPTS</b>, the compile time LUFA options which configure the library features\r

  *\r
  *  These values should be changed to reflect the build hardware.\r
  *\r
  *\r
  *  These values should be changed to reflect the build hardware.\r
  *\r


@@ -63,12 +65,23 @@
  *  library components will occur.\r
  *\r
  *  \section Sec_CDEFS The CDEFS Parameter\r
  *  library components will occur.\r
  *\r
  *  \section Sec_CDEFS The CDEFS Parameter\r

+ *  Many applications have features which can be controlled by the defining of specially named preprocessor tokens at the point of compilation - for example,\r
+ *  an application might use a compile time token to turn on or off optional or mutually exclusive portions of code. Preprocessor tokens can be\r
+ *  defined here by listing each one with the -D command line switch, and each token can optionally be defined to a specific value. When defined in the\r
+ *  project makefile, these behave as if they were defined in every source file via a normal preprocessor define statement.\r
+ *\r

  *  Most applications will actually have multiple CDEF lines, which are concatenated together with the "+=" operator. This ensures that large\r
  *  numbers of configuration options remain readable by splitting up groups of options into separate lines.\r
  *\r
  *  Most applications will actually have multiple CDEF lines, which are concatenated together with the "+=" operator. This ensures that large\r
  *  numbers of configuration options remain readable by splitting up groups of options into separate lines.\r
  *\r

- *  Normally, these options do not need to be altered to allow an application to compile and run correctly on a different board or AVR to the\r
- *  current configuration - if the options are incorrect, then the demo is most likely incompatible with the chosen USB AVR model and cannot be\r
- *  made to function through the altering of the makefile settings alone (or at all). Settings such as the USB mode (device, host or both), the USB\r
- *  interface speed (Low or Full speed) and other LUFA configuration options can be set here - refer to the library documentation for details on the\r
- *  configuration parameters.\r
+ *  \section Sec_LUFA_PATH The LUFA_PATH Parameter\r
+ *  As each LUFA program requires the LUFA library source code to compile correctly, the application must know where the LUFA library is located. This\r
+ *  value specifies the path to the LUFA library base relative to the path of the project makefile.\r
+ *\r
+ *  \section Sec_LUFA_OPTS The LUFA_OPTS Parameter\r
+ *  This value is similar to the CDEFS parameter listed elsewhere -- indeed, it is simply a convenient place to group LUFA related tokens away from the\r
+ *  application's compile time tokens. Normally, these options do not need to be altered to allow an application to compile and run correctly on a\r
+ *  different board or AVR to the current configuration - if the options are incorrect, then the demo is most likely incompatible with the chosen USB AVR\r
+ *  model and cannot be made to function through the altering of the makefile settings alone (or at all). Settings such as the USB mode (device, host or both),\r
+ *  the USB interface speed (Low or Full speed) and other LUFA configuration options can be set here - see \ref Page_TokenSummary documentation for details\r
+ *  on the available LUFA compile time configuration options.\r

  */
\ No newline at end of file
  */
\ No newline at end of file