LUFA/DoxygenPages/DirectorySummaries.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \dir Platform
   8  *  \brief Platform specific drivers.
   9  *
  10  *  This folder contains platform specific drivers and defines for various supported architectures. These may or may
  11  *  not be used in a LUFA application, and are provided for convenience purposes.
  12  *
  13  *  \dir Drivers
  14  *  \brief Library hardware and software drivers.
  15  *
  16  *  This folder contains all the library hardware and software drivers for each supported board, architecture and
  17  *  microcontroller model.
  18  *
  19  *  \dir Drivers/Misc
  20  *  \brief Miscellaneous driver files.
  21  *
  22  *  This folder contains drivers for aspects other than the USB interface, board hardware or microcontroller peripherals.
  23  *
  24  *  \dir Drivers/Peripheral
  25  *  \brief Microcontroller peripheral driver files.
  26  *
  27  *  This folder contains drivers for various low level microcontroller peripherals, usually located on the microcontroller
  28  *  die within the same physical chip.
  29  *
  30  *  \dir Drivers/USB
  31  *  \brief USB controller peripheral driver files.
  32  *
  33  *  This folder contains the complete LUFA USB stack and controller files, including the core driver and stack, as well
  34  *  as the USB class driver implementations.
  35  *
  36  *  \dir Drivers/USB/Core
  37  *  \brief Core USB driver files.
  38  *
  39  *  This folder contains the core USB stack and controller driver files, to correctly implement USB functionality on the
  40  *  target architecture and microcontroller model. This
  41  *
  42  *  \dir Drivers/USB/Class
  43  *  \brief USB Class helper driver files.
  44  *
  45  *  This folder contains drivers for implementing functionality of standardized USB classes. These are not used directly by the library,
  46  *  but provide a standard and library-maintained way of implementing functionality from some of the defined USB classes without extensive
  47  *  development effort. Is is recommended that these drivers be used where possible to reduce maintenance of user applications.
  48  *
  49  *  \dir Drivers/USB/Class/Device
  50  *  \brief USB Device Class helper driver files.
  51  *
  52  *  Device mode drivers for the standard USB classes.
  53  *
  54  *  \dir Drivers/USB/Class/Host
  55  *  \brief USB Host Class helper driver files.
  56  *
  57  *  Host mode drivers for the standard USB classes.
  58  *
  59  *  \dir Drivers/Board
  60  *  \brief Board hardware driver files.
  61  *
  62  *  This folder contains drivers for interfacing with the physical hardware on supported commercial boards, primarily from
  63  *  the Atmel corporation. Header files in this folder should be included in user applications requiring the functionality of
  64  *  hardware placed on supported boards.
  65  *
  66  *  \dir CodeTemplates
  67  *  \brief Code templates for use in LUFA powered applications.
  68  *
  69  *  This contains code templates for board drivers, sample LUFA project makefiles and other similar templates that can be copied into
  70  *  a LUFA powered application and modified to speed up development.
  71  *
  72  *  \dir CodeTemplates/DriverStubs
  73  *  \brief Driver stub header files for custom boards, to allow the LUFA board drivers to operate.
  74  *
  75  *  This contains stub files for the LUFA board drivers. If the LUFA board drivers are used with board hardware other than those
  76  *  directly supported by the library, the BOARD parameter of the application's makefile can be set to "USER", and these stub files
  77  *  copied to the "/Board/" directory of the application's folder. When fleshed out with working driver code for the custom board,
  78  *  the corresponding LUFA board APIs will work correctly with the non-standard board hardware.
  79  */
  80