src/doxy/groups.h

   1 /**     @file groups.h
   2  * @ingroup doxygenDocFiles
   3  * @brief Doxygen module groups definition
   4  *
   5  * @note The order of group definitions within this file determines the order
   6  * of them on the modules page so place new groups accordingly.
   7  */
   8
   9 /** @defgroup globalHeaders Global Headers
  10  *
  11  * These key files are included in most source files by default.
  12  *
  13  * @b Examples:
  14  * - Global defines
  15  * - Global constants
  16  * - Global variables
  17  * - Error codes
  18  * - Device header
  19  * - Struct typedefs
  20  */
  21
  22 /** @defgroup dataInitialisers Data Initialisers
  23  *
  24  * These files provide initial data definitions for items that live in flash.
  25  *
  26  * @b Examples:
  27  * - Tables
  28  * - Tunables
  29  * - Fixed config
  30  * - Lookup tables
  31  * - Global constants
  32  */
  33
  34 /** @defgroup measurementsAndCalculations Measurements And Calculations
  35  *
  36  * These files all operate on inputs in order to eventually generate outputs.
  37  *
  38  * @b Examples:
  39  * - ADC readings
  40  * - Core variable generation
  41  * - Core variable averaging
  42  * - Derived variable generation
  43  * - Fuel calculations
  44  * - Ignition calculations
  45  */
  46
  47 /** @defgroup allHeaders All Header Files
  48  *
  49  * Most of these are fairly uninteresting, hence being clost to the bottom of
  50  * the modules list. Typically they just contain function declarations for
  51  * inclusion in other source files.
  52  */
  53
  54 /** @defgroup doxygenDocFiles Doxygen Documentation Files
  55  *
  56  * These files exist purely to contain documentation for extraction
  57  * by Doxygen. Using this grouping keeps them off the file list.
  58  */