docs/doxygen/misc.cpp

   1 /*!
   2 \internal \file
   3 \brief
   4 Doxygen documentation file for group declarations etc.
   5
   6 \author Teemu Murtola <teemu.murtola@gmail.com>
   7 */
   8
   9 /*!
  10 \defgroup group_publicapi Public API
  11 \brief
  12 Classes and other symbols that are publicly accessible from user code.
  13 */
  14
  15 /*!
  16 \defgroup group_libraryapi Library API
  17 \brief
  18 Classes and other symbols that are publicly accessible within the \Gromacs
  19 library.
  20
  21 \see group_publicapi
  22 */
  23
  24 /*!
  25 \defgroup group_utilitymodules Utility Modules
  26 \brief
  27 Modules with generic utility functions.
  28 */
  29
  30 /*!
  31 \defgroup group_analysismodules Analysis Modules
  32 \brief
  33 Modules used in analysis tools.
  34
  35 A separate page describes the responsibilities of these modules:
  36 \ref page_analysisframework
  37 */
  38
  39 /*! \libinternal
  40 \defgroup group_mdrun Modules for simulation functionality
  41 \brief
  42 Modules used in running simulations with mdrun
  43 */
  44
  45 /*!
  46 \namespace gmx
  47 \brief
  48 Generic \Gromacs namespace.
  49
  50 \inpublicapi
  51 */
  52
  53 /*!
  54 \internal \namespace gmx::internal
  55 \brief
  56 Internal \Gromacs namespace.
  57
  58 This namespace is used to contain some implementation-specific functions and
  59 classes.  These are not meant for direct user access, but typically reside
  60 in public headers because of implementation reasons.
  61 */
  62
  63 /*!
  64 \file share/template/template.cpp
  65 \brief Template code for writing analysis programs.
  66
  67 See \ref page_analysistemplate for more information.
  68  */
  69
  70 /*!
  71 \example template.cpp
  72 \brief Template code for writing analysis programs.
  73
  74 See \ref page_analysistemplate for more information.
  75  */