Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / utility / messagestringcollector.h

diff --git a/src/gromacs/utility/messagestringcollector.h b/src/gromacs/utility/messagestringcollector.h
index 05f08fc4ef57f5ba1e3751e2ab34f72ea00202f4..b78af98447bb56236e563560cbda4d3852f0705c 100644 (file)
--- a/src/gromacs/utility/messagestringcollector.h
+++ b/src/gromacs/utility/messagestringcollector.h
@@ -1,38 +1,42 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 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.
  *
- *                 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::MessageStringCollector.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \inlibraryapi
  * \ingroup module_utility
  */
@@ -41,7 +45,7 @@
 
 #include <string>
 
-#include "../utility/common.h"
+#include "gromacs/utility/common.h"
 
 namespace gmx
 {
@@ -100,8 +104,8 @@ class MessageStringCollector
          *
          * \returns true if append() has been called at least once.
          *
-         * The return value is identical to \c toString().empty().
-         * Calls to startContext()/finishContext() only do not cause this
+         * The return value is identical to `toString().empty()`.
+         * Calls to startContext() or finishContext() only do not cause this
          * function to return true.
          */
         bool isEmpty() const;
@@ -127,15 +131,15 @@ class MessageStringCollector
  *
  * Example usage:
  * \code
-bool function(::gmx::MessageStringCollector *errors)
-{
-    ::gmx::MessageStringContext errcontext(errors, "In function()");
-    bool bOk = function2(errors);
-    bOk = function3(errors) && bOk;
-    // <more processing>
-    return bOk;
-}
- * \endcode
+   bool function(::gmx::MessageStringCollector *errors)
+   {
+       ::gmx::MessageStringContext errcontext(errors, "In function()");
+       bool bOk = function2(errors);
+       bOk = function3(errors) && bOk;
+       // <more processing>
+       return bOk;
+   }
+   \endcode
  *
  * \see MessageStringCollector
  * \inlibraryapi
@@ -156,7 +160,7 @@ class MessageStringContext
          * Adds a context for the given object.
          */
         MessageStringContext(MessageStringCollector *collector,
-                             const std::string &name)
+                             const std::string      &name)
             : collector_(*collector)
         {
             collector_.startContext(name);