From 30c5f94c5bbf1a5cd07858a9c037442f41b65d73 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Fillion-Robin Date: Mon, 20 Jun 2016 20:43:42 -0400 Subject: [PATCH] cmCTest: Rename "ProcessTests()" to "ProcessSteps()" and improve doxygen --- Source/cmCTest.cxx | 4 ++-- Source/cmCTest.h | 13 +++++++++---- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/Source/cmCTest.cxx b/Source/cmCTest.cxx index 4508f1368..fc218c96f 100644 --- a/Source/cmCTest.cxx +++ b/Source/cmCTest.cxx @@ -886,7 +886,7 @@ int cmCTest::ExecuteHandler(const char* shandler) return handler->ProcessHandler(); } -int cmCTest::ProcessTests() +int cmCTest::ProcessSteps() { int res = 0; bool notest = true; @@ -2207,7 +2207,7 @@ int cmCTest::ExecuteTests() cmCTestLog(this, ERROR_MESSAGE, "Problem initializing the dashboard." << std::endl); } else { - res = this->ProcessTests(); + res = this->ProcessSteps(); } this->Finalize(); } diff --git a/Source/cmCTest.h b/Source/cmCTest.h index f42a27446..5c34a94c4 100644 --- a/Source/cmCTest.h +++ b/Source/cmCTest.h @@ -129,16 +129,21 @@ public: void Finalize(); /** - * Process the tests. This is the main routine. The execution of the - * tests should look like this: + * Process the dashboard client steps. + * + * Steps are enabled using SetTest() + * + * The execution of the steps (or #Part) should look like this: * * ctest foo; * foo.Initialize(); * // Set some things on foo - * foo.ProcessTests(); + * foo.ProcessSteps(); * foo.Finalize(); + * + * \sa Initialize(), Finalize(), Part, PartInfo, SetTest() */ - int ProcessTests(); + int ProcessSteps(); /* * A utility function that returns the nightly time