Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.

This commit is contained in:
Dean Camera 2010-12-26 14:55:26 +00:00
parent 2073b96d82
commit a8b66f318d
109 changed files with 357 additions and 318 deletions

View file

@ -6,13 +6,13 @@
/** \mainpage Joystick Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick host demonstration application. This gives a simple reference
* application for implementing a USB Joystick host, for USB joysticks using
@ -56,7 +56,7 @@
*
* 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB Keyboard host, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,13 +39,13 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI host demonstration application. This demo will enumerate an attached USB-MIDI device, and print incoming MIDI note
* on and off messages on any channel to the serial port. Pressing the board joystick will send note on and off messages to
* the attached MIDI device, with the board HWB controlling the note channel.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices
@ -53,7 +53,7 @@
* AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
* of the disk will be dumped to the serial port.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mouse Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -59,7 +59,7 @@
*
* Currently only single interface mice 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mouse Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -56,7 +56,7 @@
*
* Currently only single interface mice 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Printer Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Printer host demonstration application. This gives a simple reference
* application for implementing a USB Printer host, for USB printers using
@ -51,7 +51,7 @@
* to the AVR's serial port, and a simple test page is printed using the PCL
* printer language.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as
@ -48,7 +48,7 @@
* This demo will enumerate an attached USB RNDIS device, print out its vendor ID
* and any received packets in raw form through the serial USART.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Still Image Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Still Image host demonstration application. This gives a simple reference
* application for implementing a Still Image host, for USB devices such as
@ -50,7 +50,7 @@
* information structure, open a session with the device and finally close the
* session.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile.
@ -51,7 +51,7 @@
* specific features, thus use vendor-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Generic HID Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Generic HID host demonstration application. This gives a simple reference
* application for implementing a Generic HID USB host, for any device implementing
@ -49,7 +49,7 @@
*
* Received reports from the attached device are printed to the serial port.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Joystick Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick host demonstration application. This gives a simple reference
* application for implementing a USB Joystick host, for USB joysticks using
@ -56,7 +56,7 @@
*
* 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB keyboard, for USB keyboards using
@ -58,7 +58,7 @@
*
* Currently only single interface keyboards 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard host demonstration application. This gives a simple reference
* application for implementing a USB Keyboard host, for USB keyboards using
@ -56,7 +56,7 @@
*
* Currently only single interface keyboards 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage MIDI Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,13 +39,13 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI host demonstration application. This demo will enumerate an attached USB-MIDI device, and print incoming MIDI note
* on and off messages on any channel to the serial port. Pressing the board joystick will send note on and off messages to
* the attached MIDI device, with the board HWB controlling the note channel.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mass Storage Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mass Storage host demonstration application. This gives a simple reference
* application for implementing a USB Mass Storage host, for USB storage devices
@ -53,7 +53,7 @@
* AVR. The device will then wait for HWB to be pressed, whereupon the entire ASCII contents
* of the disk will be dumped to the serial port.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mouse Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -59,7 +59,7 @@
*
* Currently only single interface mice 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Mouse Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -41,7 +41,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse host demonstration application. This gives a simple reference
* application for implementing a USB Mouse host, for USB mice using
@ -56,7 +56,7 @@
*
* Currently only single interface mice 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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Printer Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -38,7 +38,7 @@
* Full Speed Mode</td>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Printer host demonstration application. This gives a simple reference
* application for implementing a USB Printer host, for USB printers using
@ -48,7 +48,7 @@
* to the AVR's serial port, and a simple test page is printed using the PCL
* printer language.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage RNDIS Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* RNDIS host demonstration application. This gives a simple reference
* application for implementing a RNDIS Ethernet host, for USB devices such as
@ -48,7 +48,7 @@
* This demo will enumerate an attached USB RNDIS device, print out its vendor ID
* and any received packets in raw form through the serial USART.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage Still Image Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -40,7 +40,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Still Image host demonstration application. This gives a simple reference
* application for implementing a Still Image host, for USB devices such as
@ -50,7 +50,7 @@
* information structure, open a session with the device and finally close the
* session.
*
* \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.
*

View file

@ -6,13 +6,13 @@
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
* - Series 7 USB AVRs (AT90USBxxx7)
*
* \section SSec_Info USB Information:
* \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
@ -39,7 +39,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* CDC host demonstration application. This gives a simple reference application
* for implementing a USB CDC host, for CDC devices using the standard ACM profile.
@ -51,7 +51,7 @@
* specific features, thus use vendor-specific class/subclass/protocol codes to force
* the user to use specialized drivers. This demo is not compatible with such devices.
*
* \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.
*