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 \libinternal
  65 \namespace gmx::compat
  66 \brief Compatibility aliases for standard library features.
  67
  68 Provide consistent naming for standard library features that must be back-ported
  69 on some platforms.
  70 gmx::compat::some_feature may map to back-ported code or to a feature provided by
  71 the STL available on a given build platform, but by including the compatibility
  72 header and using the gmx::compat namespace, forward and backward compatible code
  73 is cleaner and clearer. In the future, when a feature is determined to be provided
  74 by the system on all supported platforms, references to gmx::compat::some_feature
  75 can be replaced, e.g. with std::some_feature, and gmx::compat::some_feature
  76 deprecated.
  77
  78 Since compatibility headers are likely to be included by other
  79 headers, there is a risk of ambiguity if code in the gmx namespace refers to an
  80 unqualified name in the std namespace. To reduce ambiguity, symbol names from
  81 gmx::compat should not be imported into scopes that are shared between multiple
  82 translation units (e.g. via `using` statements in header files).
  83
  84 \ingroup group_compatibility
  85 */
  86
  87 /*!
  88 \libinternal
  89 \defgroup group_compatibility C++ standard library compatibility helpers.
  90 \brief Provide uniform interface to selected C++ standard library features.
  91
  92 For some features not available on all platforms supported by \Gromacs,
  93 provide back-ports or mappings to available standard library implementations
  94 as appropriate.
  95 */
  96
  97 /*!
  98 \file share/template/template.cpp
  99 \brief Template code for writing analysis programs.
 100
 101 See \ref page_analysistemplate for more information.
 102  */
 103
 104 /*!
 105 \example template.cpp
 106 \brief Template code for writing analysis programs.
 107
 108 See \ref page_analysistemplate for more information.
 109  */