protocol/lufa/LUFA-120730/LUFA/DoxygenPages/DirectorySummaries.txt

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