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/compat
  56 \brief \ref group_compatibility
  57
  58 \ingroup group_compatibility
  59  */
  60
  61 /*! \internal
  62 \dir src/gromacs/compat/tests
  63 \brief Tests for \ref group_compatibility
  64
  65 \ingroup group_compatibility
  66  */
  67
  68 /*! \libinternal
  69 \dir src/gromacs/onlinehelp
  70 \brief \ref module_onlinehelp
  71
  72 \ingroup module_onlinehelp
  73  */
  74 /*! \libinternal
  75 \dir src/gromacs/onlinehelp/tests
  76 \brief Unit tests for \ref module_onlinehelp
  77
  78 \ingroup module_onlinehelp
  79  */
  80
  81 /*!
  82 \dir src/gromacs/options
  83 \brief \ref module_options
  84
  85 \ingroup module_options
  86  */
  87 /*! \libinternal
  88 \dir src/gromacs/options/tests
  89 \brief Unit tests for \ref module_options
  90
  91 \ingroup module_options
  92  */
  93
  94 /*!
  95 \dir src/gromacs/selection
  96 \brief \ref module_selection
  97
  98 \ingroup module_selection
  99  */
 100 /*! \libinternal
 101 \dir src/gromacs/selection/tests
 102 \brief Unit tests for \ref module_selection
 103
 104 \ingroup module_selection
 105  */
 106
 107 /*! \libinternal
 108 \dir src/gromacs/simd
 109 \brief \ref module_simd
 110
 111 \ingroup module_simd
 112  */
 113 /*! \libinternal
 114 \dir src/gromacs/simd/tests
 115 \brief Unit tests for \ref module_simd
 116
 117 \ingroup module_simd
 118  */
 119
 120 /*!
 121 \dir src/gromacs/trajectoryanalysis
 122 \brief \ref module_trajectoryanalysis
 123
 124 \ingroup module_trajectoryanalysis
 125  */
 126 /*! \libinternal
 127 \dir src/gromacs/trajectoryanalysis/tests
 128 \brief Unit tests for \ref module_trajectoryanalysis
 129
 130 \ingroup module_trajectoryanalysis
 131  */
 132
 133 /*!
 134 \dir src/gromacs/utility
 135 \brief \ref module_utility
 136
 137 \ingroup module_utility
 138  */
 139 /*! \libinternal
 140 \dir src/gromacs/utility/tests
 141 \brief Unit tests for \ref module_utility
 142
 143 \ingroup module_utility
 144  */
 145
 146 /*!
 147 \libinternal
 148 \dir src/programs
 149 \brief Source code for building executables, see \ref page_wrapperbinary.
 150  */
 151 /*!
 152 \libinternal
 153 \dir src/programs/mdrun
 154 \brief Source code specific to `mdrun`.
 155  */
 156 /*!
 157 \libinternal
 158 \dir src/programs/view
 159 \brief Source code specific to `gmx view`, including all X11-dependent code.
 160  */
 161
 162 /*!
 163 \libinternal
 164 \dir src/testutils
 165 \brief \ref module_testutils
 166
 167 \ingroup module_testutils
 168  */
 169 /*!
 170 \libinternal
 171 \dir src/testutils/tests
 172 \brief Unit tests for \ref module_testutils
 173
 174 \ingroup module_testutils
 175  */
 176
 177 /*!
 178 \dir share
 179 \brief Directory that contains installed data files.
 180  */
 181 /*!
 182 \dir share/template
 183 \brief Template code for writing analysis programs.
 184  */