src/gromacs/onlinehelp_doc.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \defgroup module_onlinehelp Help Formatting for Online Help (onlinehelp)
  36  * \ingroup group_utilitymodules
  37  * \brief
  38  * Provides functionality for formatting help text for console and reStructuredText.
  39  *
  40  * This module provides helper functions and classes for formatting text to the
  41  * console and as reStructuredText through a single interface.  The main
  42  * components of the module are:
  43  *  - gmx::HelpWriterContext provides a single interface that can produce both
  44  *    output formats from the same input strings and API calls.  Whenever
  45  *    possible, the output format should be abstracted using this interface,
  46  *    but in some cases code still writes out raw reStructuredText.
  47  *  - rstparser.h provides the functionality to parse reStructuredText such that
  48  *    it can be rewrapped for console output.
  49  *  - helpformat.h provides some general text-processing classes, currently
  50  *    focused on producing aligned tables for console output.
  51  *  - ihelptopic.h, helptopic.h, and helpmanager.h provide classes for
  52  *    managing a hierarchy of help topics and printing out help from this
  53  *    hierarchy.
  54  *
  55  * The formatting syntax for strings accepted by this module is described in
  56  * \ref page_onlinehelp.  The module is currently exposed outside \Gromacs only
  57  * through this formatting syntax, not any API calls.
  58  *
  59  * \author Teemu Murtola <teemu.murtola@gmail.com>
  60  */
  61 /*! \internal \file
  62  * \brief
  63  * Dummy header for \ref module_onlinehelp documentation.
  64  */