src/gromacs/commandline.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \defgroup module_commandline Command Line Parsing and Help
  32  * \ingroup group_utilitymodules
  33  * \brief
  34  * Provides functionality for parsing command-line arguments and writing help.
  35  *
  36  * This module implements gmx::CommandLineParser that assigns values to
  37  * gmx::Options (see \ref module_options) based on command-line arguments.
  38  * gmx::CommandLineHelpWriter is also provided to write help text for a program
  39  * that uses the parser.
  40  *
  41  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  42  */
  43 /*! \file
  44  * \brief
  45  * Public API convenience header for handling command-line parameters.
  46  *
  47  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  48  * \inpublicapi
  49  * \ingroup module_commandline
  50  */
  51 #ifndef GMX_COMMANDLINE_H
  52 #define GMX_COMMANDLINE_H
  53
  54 #include "commandline/cmdlinehelpwriter.h"
  55 #include "commandline/cmdlineparser.h"
  56
  57 #endif