Explanation of std test mechanism

Tests/Functional/Core/Std/CMakeLists.txt

+#   ************************************************************************************************
+#
+#   BornAgain: simulate and fit scattering at grazing incidence
+#
+#!  @file      Tests/Functional/Core/Std/CMakeLists.txt
+#!  @brief     Builds Core standard tests.
+#
+#!  @homepage  http://www.bornagainproject.org
+#!  @license   GNU General Public License v3 or higher (see COPYING)
+#!  @copyright Forschungszentrum Jülich GmbH 2018
+#!  @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
+#
+#   ************************************************************************************************
+
 include(GoogleTest) # provides gtest_discover_tests
 
 set(test TestCoreStd)

Tests/Functional/Std/README.md

@@ -7,3 +7,14 @@ Standard tests are run from
 
 This directory provides some common code that it is compiled
 separately in each of the above three directories.
+
+`StandardTest.cpp`
+: Provides TEST_F stances that define the BornAgain standard tests.
+
+`Run.cpp`
+: Defines a function `run`, which runs one standard simulation,
+regardless whether it is in a Core, Py, or GUI test.
+
+The specifities of Core vs Py vs GUI test are implemented in
+a callback function `checkSimulation`, defined differently in
+`Core/Std/Check.cpp`, `Python/..`, `GUI/..`.

Tests/Functional/Std/StandardTests.h

@@ -3,7 +3,11 @@
 //  BornAgain: simulate and fit scattering at grazing incidence
 //
 //! @file      Tests/Functional/Std/StandardTests.h
-//! @brief     Implements class StandardTestCatalog.
+//! @brief     Provides TEST_F stances that define the BornAgain standard tests.
+//!
+//!            Each of these stances runs one standard test.
+//!            The function run, defined in file Run.cpp, is the same for Core/Py/GUI std tests.
+//!            It calls a function checkSimulation that is different for those three test suites.
 //!
 //! @homepage  http://www.bornagainproject.org
 //! @license   GNU General Public License v3 or higher (see COPYING)