Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / commandline / cmdlinehelpwriter.h

diff --git a/src/gromacs/commandline/cmdlinehelpwriter.h b/src/gromacs/commandline/cmdlinehelpwriter.h
index d67c4fc4fe76c95eedfb625465b0aaf9fa4eb31d..3ffd581c7e415cb86bba081ab046e142c3f27cd0 100644 (file)
--- a/src/gromacs/commandline/cmdlinehelpwriter.h
+++ b/src/gromacs/commandline/cmdlinehelpwriter.h
@@ -1,10 +1,10 @@
 /*
  * 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
@@ -43,14 +43,16 @@
 #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.
  *
@@ -68,10 +70,6 @@ class CommandLineHelpWriter
         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.
          */
@@ -88,6 +86,18 @@ class CommandLineHelpWriter
          */
         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.
          *
@@ -95,7 +105,7 @@ class CommandLineHelpWriter
          * \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;