ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

8
Demos/Device/ClassDriver/AudioInput/AudioInput.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - 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.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Input device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* 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.
*

8
Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - 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.
*
@ -43,7 +43,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Audio demonstration application. This gives a simple reference
* application for implementing a USB Audio Output device using the
@ -61,7 +61,7 @@
* Under Windows, if a driver request dialogue pops up, select the option
* 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.
*

8
Demos/Device/ClassDriver/DualVirtualSerial/DualVirtualSerial.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -14,7 +14,7 @@
* - Series 6 USB AVRs (AT90USBxxx6)
* - 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.
*
@ -46,7 +46,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -71,7 +71,7 @@
* 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.
*

8
Demos/Device/ClassDriver/GenericHID/GenericHID.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* 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
@ -55,7 +55,7 @@
* 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.
*
* \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.
*

8
Demos/Device/ClassDriver/Joystick/Joystick.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Joystick demonstration application. This gives a simple reference
* application for implementing a USB Keyboard device, for USB Joysticks
@ -59,7 +59,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.
*

8
Demos/Device/ClassDriver/Keyboard/Keyboard.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard demonstration application. This gives a simple reference application
* for implementing a USB Keyboard using the basic USB HID drivers in all modern
@ -58,7 +58,7 @@
* other LUFA Keyboard demos, this example shows explicitly how to send multiple key presses
* 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.
*

8
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Keyboard/Mouse demonstration application. This gives a simple reference
* application for implementing a composite device containing both USB Keyboard
@ -63,7 +63,7 @@
* joystick to move the pointer, and push the joystick inwards to simulate a
* 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.
*

8
Demos/Device/ClassDriver/MIDI/MIDI.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* MIDI demonstration application. This gives a simple reference
* application for implementing the USB-MIDI class in USB devices.
@ -60,7 +60,7 @@
* This device implements MIDI-THRU mode, with the IN MIDI data being
* 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.
*

8
Demos/Device/ClassDriver/MassStorage/MassStorage.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -45,7 +45,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Dual LUN Mass Storage demonstration application. This gives a simple
* reference application for implementing a multiple LUN USB Mass Storage
@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without
* 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.
*

8
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
View file

@ -6,7 +6,7 @@
/** \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.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -49,7 +49,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Combined Mass Storage and Keyboard demonstration application. This gives a
* simple reference application for implementing a dual class USB Mass Storage
@ -72,7 +72,7 @@
* the host to reset the Mass Storage device state during long transfers without
* 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.
*

8
Demos/Device/ClassDriver/Mouse/Mouse.txt
View file

@ -6,7 +6,7 @@
/** \mainpage Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -44,7 +44,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Mouse demonstration application. This gives a simple reference
* application for implementing a USB Mouse using the basic USB HID
@ -58,7 +58,7 @@
* joystick inwards to simulate a left-button click. The HWB serves as
* the right mouse button.
*
* \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.
*

8
Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
View file

@ -6,14 +6,14 @@
/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
*
* \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)
* - Series 6 USB AVRs (AT90USBxxx6)
*
* \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:
*
* Remote Network Driver Interface demonstration application.
* This gives a simple reference application for implementing
@ -73,7 +73,7 @@
* recommended that it be replaced with an external open source TCP/IP
* stack that is feature complete, such as the uIP stack.
*
* \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.
*

8
Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.txt
View file

@ -6,7 +6,7 @@
/** \mainpage Communications Device Class (Virtual Serial Port) Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -42,7 +42,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Communications Device Class demonstration application.
* This gives a simple reference application for implementing
@ -58,7 +58,7 @@
* 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.
*

8
Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.txt
View file

@ -6,7 +6,7 @@
/** \mainpage Combined Communications Device Class (Virtual Serial Port) and Mouse Demo
*
* \section SSec_Compat Demo Compatibility:
* \section Sec_Compat Demo Compatibility:
*
* The following list indicates what microcontrollers are compatible with this demo.
*
@ -15,7 +15,7 @@
* - Series 4 USB AVRs (ATMEGAxxU4)
* - 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.
*
@ -46,7 +46,7 @@
* </tr>
* </table>
*
* \section SSec_Description Project Description:
* \section Sec_Description Project Description:
*
* Combined Communications Device Class/Mouse demonstration application.
* This gives a simple reference application for implementing a combined
@ -62,7 +62,7 @@
* 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.
*