qmk_firmware/LUFA/ManPages/DirectorySummaries.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.
 */

/** \dir LUFA/Common
 *  \brief Common library header files.
 *  
 *  This folder contains header files which are common to all parts of the LUFA library. They may be used freely in
 *  user applications.
 *
 *  \dir LUFA/Drivers
 *  \brief Library hardware and software drivers.
 *  
 *  This folder contains all the library hardware and software drivers for each supported board and USB AVR
 *  microcontroller model.
 * 
 *  \dir LUFA/Drivers/Misc
 *  \brief Miscellaneous driver files.
 *  
 *  This folder contains drivers for aspects other than the USB interface, board hardware or AVR peripherals.
 * 
 *  \dir LUFA/Drivers/Peripheral
 *  \brief USB AVR peripheral driver files.
 *  
 *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible with
 *  all USB AVR models.
 *
 *  \dir LUFA/Drivers/Peripheral/AT90USBXXX67
 *  \brief AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 AVR model peripheral driver files. Its original name is due to legacy
 *  reasons.
 *  
 *  This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible only with
 *  the AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 USB AVR models, such as the AT90USB1287. Its contents should <b>not</b> be
 *  included by the user application - the dispatch header file located in the parent directory should be used
 *  instead.
 *
 *  \dir LUFA/Drivers/USB
 *  \brief USB controller peripheral driver files.
 *  
 *  This folder contains the main header files required to implement the USB interface in the USB supporting AVR models.
 *  The header files contained directly in this folder should be included in the user application in order to gain USB
 *  functionality, and the appropriate C source files in the LowLevel and HighLevel driver folders added to the compile
 *  and link stages.
 *
 *  \dir LUFA/Drivers/USB/LowLevel
 *  \brief Low level USB driver files.
 *  
 *  This folder contains low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
 *
 *  \dir LUFA/Drivers/USB/HighLevel
 *  \brief High level USB driver files.
 *  
 *  This folder contains high level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.
 *
 *  \dir LUFA/Drivers/USB/Class
 *  \brief USB Class helper driver files.
 *  
 *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
 *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
 *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
 *
 *  \dir LUFA/Drivers/USB/Class/Device
 *  \brief USB Device Class helper driver files.
 *  
 *  Device mode drivers for the standard USB classes.
 *
 *  \dir LUFA/Drivers/USB/Class/Host
 *  \brief USB Host Class helper driver files.
 *  
 *  Host mode drivers for the standard USB classes.
 *
 *  \dir LUFA/Drivers/Board
 *  \brief Board hardware driver files.
 *  
 *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
 *  the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of
 *  hardware placed on supported boards.
 *
 *  \dir LUFA/Drivers/Board/USBKEY
 *  \brief USBKEY board hardware driver files.
 *  
 *  This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
 *  should be included instead.
 *
 *  \dir LUFA/Drivers/Board/STK526
 *  \brief STK526 board hardware driver files.
 *  
 *  This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
 *  should be included instead.
 *
 *  \dir LUFA/Drivers/Board/STK525
 *  \brief STK525 board hardware driver files.
 *  
 *  This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should
 *  not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
 *  should be included instead.
 *
 *  \dir LUFA/Drivers/Board/RZUSBSTICK
 *  \brief RZUSBSTICK board hardware driver files.
 *  
 *  This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 *  the parent Board directory should be included instead.
 *
 *  \dir LUFA/Drivers/Board/ATAVRUSBRF01
 *  \brief ATAVRUSBRF01 board hardware driver files.
 *  
 *  This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header
 *  files in this folder should not be included directly in user applications; the similarly named dispatch header files located in
 *  the parent Board directory should be included instead.
 *
 *  \dir LUFA/DriverStubs
 *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
 *  
 *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
 *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
 *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
 *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
 */
Moved all source to the trunk directory. 16 years ago			`/** \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.`
			`*/`

Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`/** \dir LUFA/Common`
Moved all source to the trunk directory. 16 years ago			`* \brief Common library header files.`
			`*`
			`* This folder contains header files which are common to all parts of the LUFA library. They may be used freely in`
			`* user applications.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers`
Moved all source to the trunk directory. 16 years ago			`* \brief Library hardware and software drivers.`
			`*`
			`* This folder contains all the library hardware and software drivers for each supported board and USB AVR`
			`* microcontroller model.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Misc`
Moved all source to the trunk directory. 16 years ago			`* \brief Miscellaneous driver files.`
			`*`
			`* This folder contains drivers for aspects other than the USB interface, board hardware or AVR peripherals.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Peripheral`
Moved all source to the trunk directory. 16 years ago			`* \brief USB AVR peripheral driver files.`
			`*`
			`* This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible with`
			`* all USB AVR models.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Peripheral/AT90USBXXX67`
Moved all source to the trunk directory. 16 years ago			`* \brief AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 AVR model peripheral driver files. Its original name is due to legacy`
			`* reasons.`
			`*`
			`* This folder contains drivers for several of the AVR internal peripherals such as the USART, compatible only with`
			`* the AT90USBXXX6, AT90USBXXX7 and ATMEGAXXU4 USB AVR models, such as the AT90USB1287. Its contents should <b>not</b> be`
State information for class drivers is now zeroed out during enumeration (both in device and host mode) to ensure sane values after each enumeration. User code should no longer explicitly set state information as this is no longer preserved. 16 years ago			`* included by the user application - the dispatch header file located in the parent directory should be used`
Moved all source to the trunk directory. 16 years ago			`* instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB`
Moved all source to the trunk directory. 16 years ago			`* \brief USB controller peripheral driver files.`
			`*`
			`* This folder contains the main header files required to implement the USB interface in the USB supporting AVR models.`
			`* The header files contained directly in this folder should be included in the user application in order to gain USB`
			`* functionality, and the appropriate C source files in the LowLevel and HighLevel driver folders added to the compile`
			`* and link stages.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB/LowLevel`
Moved all source to the trunk directory. 16 years ago			`* \brief Low level USB driver files.`
			`*`
			`* This folder contains low level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB/HighLevel`
Moved all source to the trunk directory. 16 years ago			`* \brief High level USB driver files.`
			`*`
			`* This folder contains high level USB driver source files required to implement USB functionality on the USB AVR microcontrollers.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB/Class`
Moved all source to the trunk directory. 16 years ago			`* \brief USB Class helper driver files.`
			`*`
			`* This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,`
			`* but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive`
			`* development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB/Class/Device`
Added Doxygen documentation to the Audio class driver. Added new modules for each of the new device class drivers to the library documentation. 16 years ago			`* \brief USB Device Class helper driver files.`
			`*`
			`* Device mode drivers for the standard USB classes.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/USB/Class/Host`
Added Doxygen documentation to the Audio class driver. Added new modules for each of the new device class drivers to the library documentation. 16 years ago			`* \brief USB Host Class helper driver files.`
			`*`
			`* Host mode drivers for the standard USB classes.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board`
Moved all source to the trunk directory. 16 years ago			`* \brief Board hardware driver files.`
			`*`
			`* This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from`
Spell checked non-source documentation pages. 16 years ago			`* the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of`
Moved all source to the trunk directory. 16 years ago			`* hardware placed on supported boards.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board/USBKEY`
Moved all source to the trunk directory. 16 years ago			`* \brief USBKEY board hardware driver files.`
			`*`
			`* This folder contains drivers for hardware on the Atmel USBKEY demonstration board. The header files in this folder should`
			`* not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory`
			`* should be included instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board/STK526`
Moved all source to the trunk directory. 16 years ago			`* \brief STK526 board hardware driver files.`
			`*`
			`* This folder contains drivers for hardware on the Atmel STK526 development board. The header files in this folder should`
			`* not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory`
			`* should be included instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board/STK525`
Moved all source to the trunk directory. 16 years ago			`* \brief STK525 board hardware driver files.`
			`*`
			`* This folder contains drivers for hardware on the Atmel STK525 development board. The header files in this folder should`
			`* not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory`
			`* should be included instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board/RZUSBSTICK`
Moved all source to the trunk directory. 16 years ago			`* \brief RZUSBSTICK board hardware driver files.`
			`*`
			`* This folder contains drivers for hardware on the Atmel RZUSBSTICK board, as used in the Atmel "Raven" wireless kits. The header`
			`* files in this folder should not be included directly in user applications; the similarly named dispatch header files located in`
			`* the parent Board directory should be included instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/Drivers/Board/ATAVRUSBRF01`
Add new page to the documentation listing existing LUFA powered projects, fix up some inaccuracies in the documentation. 16 years ago			`* \brief ATAVRUSBRF01 board hardware driver files.`
			`*`
			`* This folder contains drivers for hardware on the Atmel ATAVRUSBRF01 board, as used in several Atmel wireless demo kits. The header`
			`* files in this folder should not be included directly in user applications; the similarly named dispatch header files located in`
			`* the parent Board directory should be included instead.`
			`*`
Add host mode USB Class driver stubs, add beginnings of a CDC host class driver. Split out common defines/types from class drivers into a seperate common class driver directory. Make central USB Class driver dispatch headers, used for both device and host modes. 16 years ago			`* \dir LUFA/DriverStubs`
Moved all source to the trunk directory. 16 years ago			`* \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.`
			`*`
Spell checked non-source documentation pages. 16 years ago			`* This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those`
Moved all source to the trunk directory. 16 years ago			`* directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files`
			`* copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,`
			`* the corresponding LUFA board APIs will work correctly with the non-standard board hardware.`
			`*/`