Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / commandline / cmdlinehelpwriter.h
index bef3bbd21775646a51bbbeb3295b7002bba839b1..3ffd581c7e415cb86bba081ab046e142c3f27cd0 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2010,2011,2012,2013, by the GROMACS development team, led by
+ * 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.
@@ -43,7 +43,7 @@
 #ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
 #define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
 
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
 
 namespace gmx
 {
@@ -51,6 +51,8 @@ namespace gmx
 class CommandLineHelpContext;
 class Options;
 
+template <typename T> class ConstArrayRef;
+
 /*! \brief
  * Writes help information for Options in ascii format.
  *
@@ -84,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.
          *