docs/doxygen/directories.cpp

   1 /*!
   2 \internal \file
   3 \brief
   4 Doxygen documentation file for directories in the source tree.
   5
   6 \author Teemu Murtola <teemu.murtola@gmail.com>
   7 */
   8
   9 /*! \libinternal
  10 \dir docs
  11 \brief Build system and source code for various documentation items.
  12  */
  13 /*! \libinternal
  14 \dir docs/doxygen
  15 \brief Doxygen build system and general documentation content.
  16  */
  17
  18 /*!
  19 \dir src
  20 \brief Main source code directory.
  21  */
  22
  23 /*!
  24 \dir src/gromacs
  25 \brief Source code for building the `libgromacs` library.
  26  */
  27
  28 /*!
  29 \dir src/gromacs/analysisdata
  30 \brief \ref module_analysisdata
  31
  32 \ingroup module_analysisdata
  33  */
  34 /*! \libinternal
  35 \dir src/gromacs/analysisdata/tests
  36 \brief Unit tests for \ref module_analysisdata
  37
  38 \ingroup module_analysisdata
  39  */
  40
  41 /*!
  42 \dir src/gromacs/commandline
  43 \brief \ref module_commandline
  44
  45 \ingroup module_commandline
  46  */
  47 /*! \libinternal
  48 \dir src/gromacs/commandline/tests
  49 \brief Unit tests for \ref module_commandline
  50
  51 \ingroup module_commandline
  52  */
  53
  54 /*! \libinternal
  55 \dir src/gromacs/onlinehelp
  56 \brief \ref module_onlinehelp
  57
  58 \ingroup module_onlinehelp
  59  */
  60 /*! \libinternal
  61 \dir src/gromacs/onlinehelp/tests
  62 \brief Unit tests for \ref module_onlinehelp
  63
  64 \ingroup module_onlinehelp
  65  */
  66
  67 /*!
  68 \dir src/gromacs/options
  69 \brief \ref module_options
  70
  71 \ingroup module_options
  72  */
  73 /*! \libinternal
  74 \dir src/gromacs/options/tests
  75 \brief Unit tests for \ref module_options
  76
  77 \ingroup module_options
  78  */
  79
  80 /*!
  81 \dir src/gromacs/selection
  82 \brief \ref module_selection
  83
  84 \ingroup module_selection
  85  */
  86 /*! \libinternal
  87 \dir src/gromacs/selection/tests
  88 \brief Unit tests for \ref module_selection
  89
  90 \ingroup module_selection
  91  */
  92
  93 /*! \libinternal
  94 \dir src/gromacs/simd
  95 \brief \ref module_simd
  96
  97 \ingroup module_simd
  98  */
  99 /*! \libinternal
 100 \dir src/gromacs/simd/tests
 101 \brief Unit tests for \ref module_simd
 102
 103 \ingroup module_simd
 104  */
 105
 106 /*!
 107 \dir src/gromacs/trajectoryanalysis
 108 \brief \ref module_trajectoryanalysis
 109
 110 \ingroup module_trajectoryanalysis
 111  */
 112 /*! \libinternal
 113 \dir src/gromacs/trajectoryanalysis/tests
 114 \brief Unit tests for \ref module_trajectoryanalysis
 115
 116 \ingroup module_trajectoryanalysis
 117  */
 118
 119 /*!
 120 \dir src/gromacs/utility
 121 \brief \ref module_utility
 122
 123 \ingroup module_utility
 124  */
 125 /*! \libinternal
 126 \dir src/gromacs/utility/tests
 127 \brief Unit tests for \ref module_utility
 128
 129 \ingroup module_utility
 130  */
 131
 132 /*!
 133 \libinternal
 134 \dir src/programs
 135 \brief Source code for building executables, see \ref page_wrapperbinary.
 136  */
 137 /*!
 138 \libinternal
 139 \dir src/programs/mdrun
 140 \brief Source code specific to `mdrun`.
 141  */
 142 /*!
 143 \libinternal
 144 \dir src/programs/view
 145 \brief Source code specific to `gmx view`, including all X11-dependent code.
 146  */
 147
 148 /*!
 149 \libinternal
 150 \dir src/testutils
 151 \brief \ref module_testutils
 152
 153 \ingroup module_testutils
 154  */
 155 /*!
 156 \libinternal
 157 \dir src/testutils/tests
 158 \brief Unit tests for \ref module_testutils
 159
 160 \ingroup module_testutils
 161  */
 162
 163 /*!
 164 \dir share
 165 \brief Directory that contains installed data files.
 166  */
 167 /*!
 168 \dir share/template
 169 \brief Template code for writing analysis programs.
 170  */