Better solution - change compile time token names to DEVICE_STATE_AS_GPIOR and HOST_S...

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

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 130a2e8..513d854 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -95,17 +95,19 @@
  *  defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled\r
  *  binary.\r
  *\r
  *  defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled\r
  *  binary.\r
  *\r

- *  <b>DEVICE_STATE_AS_GPIOR0</b> - ( \ref Group_Device ) \n\r
+ *  <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n\r

  *  One of the most frequenty used global variables in the stack is the USB_DeviceState global, which indicates the current state of\r
  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r
  *  One of the most frequenty used global variables in the stack is the USB_DeviceState global, which indicates the current state of\r
  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r

- *  make be defined to fix the state variable into one of the three general purpose IO registers inside the AVR reserved for application\r
- *  use. When defined, the GPIOR0 register should not be used within the user application except implicitly via the library APIs.\r
+ *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR\r
+ *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except\r
+ *  implicitly via the library APIs.\r

  *\r
  *\r

- *  <b>HOST_STATE_AS_GPIOR1</b> - ( \ref Group_Host ) \n\r
+ *  <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n\r

  *  One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of\r
  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r
  *  One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of\r
  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token\r

- *  make be defined to fix the state variable into one of the three general purpose IO registers inside the AVR reserved for application\r
- *  use. When defined, the GPIOR1 register should not be used within the user application except implicitly via the library APIs.\r
+ *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR\r
+ *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except\r
+ *  implicitly via the library APIs.\r

  *\r
  *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n\r
  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces\r
  *\r
  *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n\r
  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces\r