Sort all includes in src/gromacs

[alexxy/gromacs.git] / src / gromacs / utility / errorcodes.cpp

diff --git a/src/gromacs/utility/errorcodes.cpp b/src/gromacs/utility/errorcodes.cpp
index da02091926eac63832968cd1beae02957c73f0f6..00c57aa67c4ac86d3f71fba0b1c96aaedf72d883 100644 (file)
--- a/src/gromacs/utility/errorcodes.cpp
+++ b/src/gromacs/utility/errorcodes.cpp
@@ -1,45 +1,51 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * 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.
  *
- *                 G   R   O   M   A   C   S
- *
- *          GROningen MAchine for Chemical Simulations
+ * 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.
  *
- * 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.
+ * 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.
  *
- * 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.
  */
 /*! \internal \file
  * \brief
  * Implements functions in errorcodes.h.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_utility
  */
-#include "gromacs/utility/errorcodes.h"
+#include "gmxpre.h"
+
+#include "errorcodes.h"
 
 #include <cstdlib>
 
-#include "gromacs/legacyheaders/thread_mpi/mutex.h"
+#include "thread_mpi/mutex.h"
 
 #include "errorformat.h"
 
@@ -49,6 +55,9 @@ namespace gmx
 namespace
 {
 
+//! \addtogroup module_utility
+//! \{
+
 /*! \brief
  * Strings corresponding to gmx::ErrorCode values.
  *
@@ -90,10 +99,12 @@ void standardErrorHandler(int retcode, const char *msg,
 
 //! Global error handler set with setFatalErrorHandler().
 ErrorHandlerFunc g_errorHandler = standardErrorHandler;
-//! Mutex for protecting access to g_errorHandler.
-tMPI::mutex handler_mutex;
+//! Mutex for protecting access to ::g_errorHandler.
+tMPI::mutex      handler_mutex;
+
+//! \}
 
-} // namespace
+}   // namespace
 
 const char *getErrorCodeString(int errorcode)
 {
@@ -107,7 +118,7 @@ const char *getErrorCodeString(int errorcode)
 ErrorHandlerFunc setFatalErrorHandler(ErrorHandlerFunc handler)
 {
     tMPI::lock_guard<tMPI::mutex> lock(handler_mutex);
-    ErrorHandlerFunc oldHandler = g_errorHandler;
+    ErrorHandlerFunc              oldHandler = g_errorHandler;
     g_errorHandler = handler;
     return oldHandler;
 }
@@ -129,7 +140,7 @@ void fatalError(int retcode, const char *msg, const char *file, int line)
     }
 }
 
-} // namespace internal
+}   // namespace internal
 //! \endcond
 
 } // namespace gmx