Refactor mdrun integration tests
[alexxy/gromacs.git] / src / testutils / integrationtests.h
index 6e3991b035822f9e7a1807eaf7471232069c0c88..f62da517671225d36fce96004ecef0a5da79726f 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the GROMACS molecular simulation package.
  *
- * Copyright (c) 2013, by the GROMACS development team, led by
+ * Copyright (c) 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.
  * To help us fund GROMACS development, we humbly ask that you cite
  * the research papers on the package. Check out http://www.gromacs.org.
  */
-/*! \internal \file
+/*! \libinternal \file
  * \brief
  * Declares test fixture for integration tests
  *
  * \author Mark Abraham <mark.j.abraham@gmail.com>
+ * \inlibraryapi
  * \ingroup module_testutils
  */
 #ifndef GMX_INTEGRATION_TESTS_MODULETEST_H
@@ -57,6 +58,7 @@ namespace test
  *
  * Any method in this class may throw std::bad_alloc if out of memory.
  *
+ * \inlibraryapi
  * \ingroup module_testutils
  */
 class IntegrationTestFixture : public ::testing::Test
@@ -73,28 +75,28 @@ class IntegrationTestFixture : public ::testing::Test
          */
         void redirectStringToStdin(const char* theString);
 
-        /*! Discards stdout while running a test
+        /*! \brief Discards stdout while running a test
          *
          * \todo Implement this when the output routines are
          * sufficiently modular to permit it to work. */
         void redirectStdoutToDevNull();
-        /*! Discards stderr while running a test
+        /*! \brief Discards stderr while running a test
          *
          * \todo Implement this when the output routines are
          * sufficiently modular to permit it to work. */
         void redirectStderrToDevNull();
 
-        /* TEST_F() constructs derived classes, and those classes
-         * might need to access implementation details, so we
-         * cannot use the private access specifer here. */
-    protected:
+        /* TEST_F() constructs derived classes, and those classes and
+         * their member objects might need to access implementation
+         * details, so we cannot use the private access specifer
+         * here. */
+    public:
 
         /*! \brief Object that manages finding input files, writing
          * temporary output files and cleaning up files.
          */
         ::gmx::test::TestFileManager fileManager_;
 
-    public:
         //! Number of backup files to write
         static std::string s_maxBackup;
 };