Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / onlinehelp / helpmanager.h

diff --git a/src/gromacs/onlinehelp/helpmanager.h b/src/gromacs/onlinehelp/helpmanager.h
index fc188100e73c643849ed250ef1589323c0027095..4418edf871f2afd6918878e826e6f84cfaa9ec7d 100644 (file)
--- a/src/gromacs/onlinehelp/helpmanager.h
+++ b/src/gromacs/onlinehelp/helpmanager.h
@@ -1,45 +1,51 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2012,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.
  *
- *                 G   R   O   M   A   C   S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \libinternal \file
  * \brief
  * Declares gmx::HelpManager.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
  * \ingroup module_onlinehelp
  */
 #ifndef GMX_ONLINEHELP_HELPMANAGER_H
 #define GMX_ONLINEHELP_HELPMANAGER_H
 
-#include "../utility/common.h"
+#include <string>
+
+#include "gromacs/utility/common.h"
 
 namespace gmx
 {
@@ -68,7 +74,7 @@ class HelpManager
          * lifetime of this manager object.
          */
         HelpManager(const HelpTopicInterface &rootTopic,
-                    const HelpWriterContext &context);
+                    const HelpWriterContext  &context);
         ~HelpManager();
 
         /*! \brief
@@ -79,6 +85,8 @@ class HelpManager
          * \throws    InvalidInputError if topic with \p name is not found.
          */
         void enterTopic(const char *name);
+        //! \copydoc enterTopic(const char *)
+        void enterTopic(const std::string &name);
 
         /*! \brief
          * Writes out the help for the currently active topic.