Commit a8b66f31 authored by Dean Camera's avatar Dean Camera
Browse files

Documentation improvements - put driver example code into its own section, fix...

Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
parent 2073b96d
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage CDC Class USB AVR Bootloader /** \mainpage CDC Class USB AVR Bootloader
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109 * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
* protocol compatible programming software to load firmware onto the AVR. * protocol compatible programming software to load firmware onto the AVR.
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
* This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the * This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the
* device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers. * device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage DFU Class USB AVR Bootloader /** \mainpage DFU Class USB AVR Bootloader
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
* software to load firmware onto the AVR. * software to load firmware onto the AVR.
...@@ -69,7 +69,7 @@ ...@@ -69,7 +69,7 @@
* drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please * drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
* manually change them in Descriptors.c and alter your driver's INF file accordingly. * manually change them in Descriptors.c and alter your driver's INF file accordingly.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Audio Input Device Demo /** \mainpage Audio Input Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6) * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -43,7 +43,7 @@ ...@@ -43,7 +43,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Audio demonstration application. This gives a simple reference * Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the * application for implementing a USB Audio Input device using the
...@@ -61,7 +61,7 @@ ...@@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option * Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers. * to automatically install the appropriate drivers.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Audio Output Device Demo /** \mainpage Audio Output Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6) * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -43,7 +43,7 @@ ...@@ -43,7 +43,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Audio demonstration application. This gives a simple reference * Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the * application for implementing a USB Audio Output device using the
...@@ -61,7 +61,7 @@ ...@@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option * Under Windows, if a driver request dialogue pops up, select the option
* to automatically install the appropriate drivers. * to automatically install the appropriate drivers.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device /** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6) * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Dual Communications Device Class demonstration application. * Dual Communications Device Class demonstration application.
* This gives a simple reference application for implementing * This gives a simple reference application for implementing
...@@ -71,7 +71,7 @@ ...@@ -71,7 +71,7 @@
* Operating Systems should automatically use their own inbuilt * Operating Systems should automatically use their own inbuilt
* CDC-ACM drivers. * CDC-ACM drivers.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Generic HID Device /** \mainpage Generic HID Device
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Generic HID device demonstration application. This gives a simple reference application * Generic HID device demonstration application. This gives a simple reference application
* for implementing a generic HID device, using the basic USB HID drivers in all modern * for implementing a generic HID device, using the basic USB HID drivers in all modern
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
* When controlled by a custom HID class application, reports can be sent and received by * When controlled by a custom HID class application, reports can be sent and received by
* both the standard data endpoint and control request methods defined in the HID specification. * both the standard data endpoint and control request methods defined in the HID specification.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Joystick Device Demo /** \mainpage Joystick Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Joystick demonstration application. This gives a simple reference * Joystick demonstration application. This gives a simple reference
* application for implementing a USB Keyboard device, for USB Joysticks * application for implementing a USB Keyboard device, for USB Joysticks
...@@ -59,7 +59,7 @@ ...@@ -59,7 +59,7 @@
* *
* Currently only single interface joysticks are supported. * Currently only single interface joysticks are supported.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Keyboard Device Demo /** \mainpage Keyboard Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Keyboard demonstration application. This gives a simple reference application * Keyboard demonstration application. This gives a simple reference application
* for implementing a USB Keyboard using the basic USB HID drivers in all modern * for implementing a USB Keyboard using the basic USB HID drivers in all modern
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
* other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses * other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
* inside the same report to the host. * inside the same report to the host.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Dual HID Keyboard and Mouse Device Demo /** \mainpage Dual HID Keyboard and Mouse Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Keyboard/Mouse demonstration application. This gives a simple reference * Keyboard/Mouse demonstration application. This gives a simple reference
* application for implementing a composite device containing both USB Keyboard * application for implementing a composite device containing both USB Keyboard
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
* joystick to move the pointer, and push the joystick inwards to simulate a * joystick to move the pointer, and push the joystick inwards to simulate a
* left-button click. * left-button click.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage MIDI Input Device Demo /** \mainpage MIDI Input Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* MIDI demonstration application. This gives a simple reference * MIDI demonstration application. This gives a simple reference
* application for implementing the USB-MIDI class in USB devices. * application for implementing the USB-MIDI class in USB devices.
...@@ -60,7 +60,7 @@ ...@@ -60,7 +60,7 @@
* This device implements MIDI-THRU mode, with the IN MIDI data being * This device implements MIDI-THRU mode, with the IN MIDI data being
* generated by the device itself. OUT MIDI data is discarded. * generated by the device itself. OUT MIDI data is discarded.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Mass Storage Device Demo /** \mainpage Mass Storage Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -45,7 +45,7 @@ ...@@ -45,7 +45,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Dual LUN Mass Storage demonstration application. This gives a simple * Dual LUN Mass Storage demonstration application. This gives a simple
* reference application for implementing a multiple LUN USB Mass Storage * reference application for implementing a multiple LUN USB Mass Storage
...@@ -72,7 +72,7 @@ ...@@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without * the host to reset the Mass Storage device state during long transfers without
* the need for complicated polling logic. * the need for complicated polling logic.
* *
* \section SSec_Options Project Options * \section Sec_Options Project Options
* *
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
* *
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
/** \mainpage Combined Mass Storage and Keyboard Device Demo /** \mainpage Combined Mass Storage and Keyboard Device Demo
* *
* \section SSec_Compat Demo Compatibility: * \section Sec_Compat Demo Compatibility:
* *
* The following list indicates what microcontrollers are compatible with this demo. * The following list indicates what microcontrollers are compatible with this demo.
* *
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4) * - Series 4 USB AVRs (ATMEGAxxU4)
* - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
* *
* \section SSec_Info USB Information: * \section Sec_Info USB Information:
* *
* The following table gives a rundown of the USB utilization of this demo. * The following table gives a rundown of the USB utilization of this demo.
* *
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
* </tr> * </tr>
* </table> * </table>
* *
* \section SSec_Description Project Description: * \section Sec_Description Project Description:
* *
* Combined Mass Storage and Keyboard demonstration application. This gives a * Combined Mass Storage and Keyboard demonstration application. This gives a
* simple reference application for implementing a dual class USB Mass Storage * simple reference application for implementing a dual class USB Mass Storage
...@@ -72,7 +72,7 @@ ...@@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long