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