diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf index dbf81d5b93632405614a323ebdd30645fecb15ee..bde67eee1039f86208b88dfddff4eba9b57a7f7f 100644 --- a/LUFA/Doxygen.conf +++ b/LUFA/Doxygen.conf @@ -257,7 +257,7 @@ EXTENSION_MAPPING = # can mix doxygen, HTML, and XML commands with Markdown formatting. # Disable only in case of backward compatibilities issues. -MARKDOWN_SUPPORT = YES +MARKDOWN_SUPPORT = NO # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should diff --git a/LUFA/DoxygenPages/GettingStarted.txt b/LUFA/DoxygenPages/GettingStarted.txt index ab460cb6e19e3595e9480c7b65b460eec50dee79..18c86889674910f4ef3027502bfe8bd5b7f0716e 100644 --- a/LUFA/DoxygenPages/GettingStarted.txt +++ b/LUFA/DoxygenPages/GettingStarted.txt @@ -17,8 +17,6 @@ * to LUFA, it is highly recommended that you look at the ClassDriver versions first, which use the pre-made USB * Class Drivers (\ref Group_USBClassDrivers) to simplify the use of the standard USB classes in user applications. * - * For an overview of the included library applications, bootloaders and demos, see \ref Page_LibraryApps. - * * <b>Subsections:</b> * \li \subpage Page_ConfiguringApps - How to Configure the Included Demos, Projects and Bootloaders * \li \subpage Page_CompilingApps - How to Compile the Included Demos, Projects and Bootloaders diff --git a/LUFA/DoxygenPages/LibraryApps.txt b/LUFA/DoxygenPages/LibraryApps.txt deleted file mode 100644 index 76dea8b08dcdd83f107e2d9af0e5418d6f81cf6f..0000000000000000000000000000000000000000 --- a/LUFA/DoxygenPages/LibraryApps.txt +++ /dev/null @@ -1,128 +0,0 @@ -/** \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. - */ - -/** \page Page_LibraryApps Included Library Applications - * - * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. Within this - * directory the demos are separated by USB mode (Device, Host, OTG) and further separated by the use or non-use of the - * library USB Class drivers (which abstract out the actual implementation of the USB classes to simplify development even - * further at the expense of a loss of flexibility). - * - * With one or two exceptions (e.g. proprietary classes such as RNDIS) all the included demos will work across all OSes without - * the need for special drivers. On Windows, some demos require the supplied .INF file to be used as the device driver, which - * directs the OS to use its inbuilt class drivers for the device. - * - * Also included with the library are two fully functional bootloaders, located in the /Bootloaders/ subdirectory. - * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, while - * the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP. - * - * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, - * please email it to the Library author. - * - * \section Sec_AppOverview Overview of Included Library Applications - * The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted - * open source projects. - * - * <small> - * - * - <b>Demos</b> - * - <b>Device</b> - * - <b>ClassDriver</b> - * - <b>AudioInput</b> - Audio In (microphone) demo, using the library USB Audio Class driver framework - * - <b>AudioOutput</b> - Audio Out (speaker) demo, using the library USB Audio Class driver framework - * - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework - * - <b>GenericHID</b> - Generic Human Interface Class demo, using the library USB HID Class driver framework - * - <b>Joystick</b> - USB Joystick demo, using the library USB HID Class driver framework - * - <b>Keyboard</b> - USB Keyboard demo, using the library USB HID Class driver framework - * - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework - * - <b>KeyboardMouseMultiReport</b> - Multi HID report Keyboard/Mouse demo, using the library USB HID Class driver framework - * - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework - * - <b>MassStorageKeyboard</b> - Mass Storage and Keyboard demo, using the library USB Mass Storage/HID Class driver frameworks - * - <b>MIDI</b> - MIDI In demo, using the library USB MIDI-Audio Class driver framework - * - <b>Mouse</b> - USB Mouse demo, using the library USB HID driver framework - * - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework - * - <b>VirtualSerial</b> - Virtual Serial Port demo, using the library USB CDC Class driver framework - * - <b>VirtualSerialMassStorage</b> - Virtual Serial Port and Mass Storage demo, using the library USB CDC and Mass Storage Class driver frameworks - * - <b>VirtualSerialMouse</b> - Virtual Serial Port and Mouse demo, using the library USB CDC and HID Class driver frameworks - * - <b>LowLevel</b> - * - <b>AudioInput</b> - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class - * - <b>AudioOutput</b> - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class - * - <b>DualVirtualSerial</b> - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class - * - <b>GenericHID</b> - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class - * - <b>Joystick</b> - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class - * - <b>Keyboard</b> - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class - * - <b>KeyboardMouse</b> - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class - * - <b>MassStorage</b> - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class - * - <b>MIDI</b> - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class - * - <b>Mouse</b> - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class - * - <b>RNDISEthernet</b> - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class - * - <b>VirtualSerial</b> - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class - * - <b>Incomplete</b> - * - <b>SideShow</b> - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class - * - <b>TestAndMeasurement</b> - Incomplete Test and Measurement demo, using the low level LUFA APIs to implement the USB Test and - * Measurement class - * - <b>Host</b> - * - <b>ClassDriver</b> - * - <b>AndroidAccessoryHost</b> - Android Accessory host demo, using the library USB Android Open Accessory Class driver framework - * - <b>AudioInputHost</b> - Audio Input host demo, using the library USB Audio Class driver framework - * - <b>AudioOutputHost</b> - Audio Output host demo, using the library USB Audio Class driver framework - * - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the library USB HID Class driver framework - * - <b>KeyboardHost</b> - USB Keyboard host demo, using the library USB HID Class driver framework - * - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class - * driver framework - * - <b>MassStorageHost</b> - Mass Storage host demo, using the library USB Mass Storage Class driver framework - * - <b>MouseHost</b> - Mouse host demo, using the library USB HID Class driver framework - * - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework - * - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the library USB RNDIS Class driver framework - * - <b>StillImageHost</b> - Still Image Camera host demo, using the library USB Still Image Class driver framework - * - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the library USB CDC Class driver framework - * - <b>LowLevel</b> - * - <b>AndroidAccessoryHost</b> - Android Accessory host demo, using the low level LUFA APIs to implement the Android Open Accessory class - * - <b>AudioInputHost</b> - Audio Input host demo, using the low level LUFA APIs to implement the USB Audio class - * - <b>AudioOutputHost</b> - Audio Output host demo, using the low level LUFA APIs to implement the USB Audio class - * - <b>GenericHIDHost</b> - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class - * - <b>JoystickHostWithParser</b> - Joystick host demo with HID Descriptor parser, using the low level LUFA APIs to implement - * the USB HID class - * - <b>KeyboardHost</b> - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class - * - <b>KeyboardHostWithParser</b> - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to - * implement the USB HID class - * - <b>MassStorageHost</b> - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class - * - <b>MouseHost</b> - Mouse host demo, using the low level LUFA APIs to implement the USB HID class - * - <b>MouseHostWithParser</b> - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the - * USB HID class - * - <b>PrinterHost</b> - Printer host demo, using the low level LUFA APIs to implement the USB Printer class - * - <b>RNDISHost</b> - RNDIS Ethernet host demo, using the low level LUFA APIs to implement the RNDIS class - * - <b>StillImageHost</b> - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class - * - <b>VirtualSerialHost</b> - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class - * - <b>Incomplete</b> - * - <b>BluetoothHost</b> - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class - * - <b>DualRole</b> - * - <b>ClassDriver</b> - * - <b>MouseHostDevice</b> - Dual role Mouse Host and Mouse Device demo, using the library USB CDC Class driver framework - * - <b>Bootloaders</b> - * - <b>CDC</b> - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude - * - <b>DFU</b> - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software - * - <b>HID</b> - HID Class USB bootloader, compatible with a modified PJRC TeensyHID protocol loader application software - * - <b>Projects</b> - * - <b>AVRISP-MKII</b> - AVRISP-MKII Programmer Clone project - * - <b>Benito</b> - Benito Board Arduino Programmer project - * - <b>HIDReportViewer</b> - HID Device Report Viewer project - * - <b>LEDNotifier</b> - USB LED Notification project - * - <b>Magstripe</b> - Magnetic Stripe Card Reader project - * - <b>MediaController</b> - Media Playback Controller project - * - <b>MIDIToneGenerator</b> - MIDI Note Tone Generator project - * - <b>MissileLaucher</b> - Toy Missile Launcher Host project - * - <b>RelayBoard</b> - Relay board controller, controllable via the "sismpctl" Linux application - * - <b>TempDataLogger</b> - Temperature Datalogging project, using the FatFS library - * - <b>USBtoSerial</b> - USB to USART Serial Converter project - * - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library - * - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project - * - <b>Incomplete</b> - * - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk - * - * </small> - */ - diff --git a/LUFA/DoxygenPages/MainPage.txt b/LUFA/DoxygenPages/MainPage.txt index c7f84dbd1d02ff5f02f8dba5957a37911e1602f8..994ba986b676e6cc425bc4e21f623cdb14f8f581 100644 --- a/LUFA/DoxygenPages/MainPage.txt +++ b/LUFA/DoxygenPages/MainPage.txt @@ -43,6 +43,5 @@ * \li \subpage Page_Donating - Donating to support this project * \li \subpage Page_AboutLUFA - LUFA Support and Resources * \li \subpage Page_WhyUseLUFA - What are the advantages of using LUFA? - * \li \subpage Page_LibraryApps - Overview of included Demos, Bootloaders and Projects */