src/gromacs/onlinehelp.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 /*! \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 other
  39  * formats.
  40  *
  41  * This module provides helper functions and classes for formatting console
  42  * help, as well as man pages and HTML help from the source code.  It should
  43  * not be necessary to call any methods in this module outside the \Gromacs
  44  * library.
  45  *
  46  * \author Teemu Murtola <teemu.murtola@gmail.com>
  47  */
  48 /*! \file
  49  * \brief
  50  * Public API convenience header for help formatting.
  51  *
  52  * This module does not provide any classes that are intended to be used
  53  * outside the library.  It only contains some type declarations that are
  54  * necessary for implementation reasons in other public API headers.
  55  *
  56  * \author Teemu Murtola <teemu.murtola@gmail.com>
  57  * \inlibraryapi
  58  * \ingroup module_onlinehelp
  59  */
  60 #ifndef GMX_ONLINEHELP_H
  61 #define GMX_ONLINEHELP_H
  62
  63 #include "onlinehelp/helptopicinterface.h"
  64
  65 #endif