qmk_firmware/Bootloaders/TeensyHID/TeensyHID.txt

/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */
 
/** \mainpage Teensy HID Class USB AVR Bootloader
 *
 *  \section SSec_Compat Demo Compatibility:
 *
 *  The following table indicates what microcontrollers are compatible with this demo.
 *
 *  - AT90USB646
 *  - AT90USB162
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
 * <table>
 *  <tr>
 *   <td><b>USB Mode:</b></td>
 *   <td>Device</td>
 *  </tr>
 *  <tr>
 *   <td><b>USB Class:</b></td>
 *   <td>Human Interface Device Class (HID)</td>
 *  </tr>
 *  <tr> 
 *   <td><b>USB Subclass:</b></td>
 *   <td>N/A</td>
 *  </tr>
 *  <tr>
 *   <td><b>Relevant Standards:</b></td>
 *   <td>USBIF HID Class Standard</td>
 *   <td>Teensy Programming Protocol Details</td>
 *  </tr>
 *  <tr>
 *   <td><b>Usable Speeds:</b></td>
 *   <td>Low Speed Mode</td>
 *   <td>Full Speed Mode</td>
 *  </tr>
 * </table>
 *
 *  \section SSec_Description Project Description: 
 *
 * This bootloader enumerates to the host as a HID Class device, allowing for Teensy compatible programming
 * software to load firmware onto the AVR, such as the official software at http://www.pjrc.com/teensy/.
 *  
 * Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
 *
 * This spoofs (with permission) the official Teensy bootloader's VID and PID, so that the software remains
 * compatible with no changes.
 *
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
 *    <td>
 *     None
 *    </td>
 *   </tr>
 *  </table>
 */