Hide the PROGMEM attribute from Doxygen, as it appears to confuse the parser in some...

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

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 046101e..fbfbc3d 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -28,7 +28,7 @@
  *  By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID
  *  communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic
  *  Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol
  *  By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID
  *  communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic
  *  Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol

- *  mode can be removed to save space in the compiled application by defining this token. When defined, it is still neccesary
+ *  mode can be removed to save space in the compiled application by defining this token. When defined, it is still necessary

  *  to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().
  * 
  *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
  *  to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().
  * 
  *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \ref Group_HIDParser ) \n


@@ -61,7 +61,7 @@
  *
  *  <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - ( \ref Group_HIDParser ) \n
  *  HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination
  *
  *  <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - ( \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
+ *  keyboard and mouse might use report IDs to separate 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
  *  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


@@ -83,7 +83,7 @@
  *  By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full
  *  or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,
  *  this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is
  *  By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full
  *  or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However,
  *  this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is

- *  used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption
+ *  used, bytes are sent or received in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption

  *  due to the extra code required to deal with byte alignment.
  *
  *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n
  *  due to the extra code required to deal with byte alignment.
  *
  *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \ref Group_USBManagement ) \n


@@ -143,7 +143,7 @@
  *  binary.
  *
  *  <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n
  *  binary.
  *
  *  <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n

- *  One of the most frequenty used global variables in the stack is the USB_DeviceState global, which indicates the current state of
+ *  One of the most frequently used global variables in the stack is the USB_DeviceState global, which indicates the current state of

  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  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
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  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
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except


@@ -161,7 +161,7 @@
  *  endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
  *
  *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \ref Group_USBManagement ) \n
  *  endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
  *
  *  <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.
+ *  Some applications prefer to not call the USB_USBTask() management task regularly while in device mode, as it can complicate code significantly.

  *  Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control
  *  endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called
  *  when in USB device mode.
  *  Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control
  *  endpoint entirely via USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called
  *  when in USB device mode.


@@ -181,7 +181,7 @@
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.
  *
  *  <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.
  *
  *  <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n

- *  One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of
+ *  One of the most frequently used global variables in the stack is the USB_HostState global, which indicates the current state of

  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  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
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  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
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except