/*
* This file is part of the GROMACS molecular simulation package.
*
- * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
- * David van der Spoel, Berk Hess, Erik Lindahl, and including many
- * others, as listed in the AUTHORS file in the top-level source
- * directory and at http://www.gromacs.org.
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
* GROMACS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
#ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
#define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
namespace gmx
{
-class HelpWriterContext;
+class CommandLineHelpContext;
class Options;
+template <typename T> class ConstArrayRef;
+
/*! \brief
* Writes help information for Options in ascii format.
*
explicit CommandLineHelpWriter(const Options &options);
~CommandLineHelpWriter();
- /*! \brief
- * Sets whether hidden options are shown in the help.
- */
- CommandLineHelpWriter &setShowHidden(bool bShow);
/*! \brief
* Sets whether long descriptions for sections are shown in the help.
*/
*/
CommandLineHelpWriter &setTimeUnitString(const char *timeUnit);
+ /*! \brief
+ * Sets the list of known bugs/limitations.
+ *
+ * \param[in] bugs Array of bugs/limitations.
+ *
+ * Each entry in the input array identifies a separate issue.
+ * The array passed should remain valid for the lifetime of the writer
+ * object.
+ */
+ CommandLineHelpWriter &
+ setKnownIssues(const ConstArrayRef<const char *> &bugs);
+
/*! \brief
* Writes the help.
*
* \throws std::bad_alloc if out of memory.
* \throws FileIOError on any I/O error.
*/
- void writeHelp(const HelpWriterContext &context);
+ void writeHelp(const CommandLineHelpContext &context);
private:
class Impl;