diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 13:57:57 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 13:57:57 +0000 |
commit | ab76c52e1414c55a2f594999ca2a04918bbc7143 (patch) | |
tree | 5c840ac7122d8338aa10723b4fa255c8a16317a7 /LUFA/DirectorySummaries.txt | |
parent | 84d77833503151acffbdda6217fa8ce59c6b4b8a (diff) | |
download | lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.tar.gz lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.tar.bz2 lufa-ab76c52e1414c55a2f594999ca2a04918bbc7143.zip |
Move main library documentation pages into a new ManPages subdirectory.
Diffstat (limited to 'LUFA/DirectorySummaries.txt')
-rw-r--r-- | LUFA/DirectorySummaries.txt | 123 |
1 files changed, 0 insertions, 123 deletions
diff --git a/LUFA/DirectorySummaries.txt b/LUFA/DirectorySummaries.txt deleted file mode 100644 index 3b2c15fca..000000000 --- a/LUFA/DirectorySummaries.txt +++ /dev/null @@ -1,123 +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.
- */
-
-/** \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 AT90USBXXX 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.
- */
|