cmCTest: Rename "ProcessTests()" to "ProcessSteps()" and improve doxygen

This commit is contained in:
Jean-Christophe Fillion-Robin 2016-06-20 20:43:42 -04:00 committed by Brad King
parent 7c87ab755c
commit 30c5f94c5b
2 changed files with 11 additions and 6 deletions

View File

@ -886,7 +886,7 @@ int cmCTest::ExecuteHandler(const char* shandler)
return handler->ProcessHandler(); return handler->ProcessHandler();
} }
int cmCTest::ProcessTests() int cmCTest::ProcessSteps()
{ {
int res = 0; int res = 0;
bool notest = true; bool notest = true;
@ -2207,7 +2207,7 @@ int cmCTest::ExecuteTests()
cmCTestLog(this, ERROR_MESSAGE, "Problem initializing the dashboard." cmCTestLog(this, ERROR_MESSAGE, "Problem initializing the dashboard."
<< std::endl); << std::endl);
} else { } else {
res = this->ProcessTests(); res = this->ProcessSteps();
} }
this->Finalize(); this->Finalize();
} }

View File

@ -129,16 +129,21 @@ public:
void Finalize(); void Finalize();
/** /**
* Process the tests. This is the main routine. The execution of the * Process the dashboard client steps.
* tests should look like this: *
* Steps are enabled using SetTest()
*
* The execution of the steps (or #Part) should look like this:
* *
* ctest foo; * ctest foo;
* foo.Initialize(); * foo.Initialize();
* // Set some things on foo * // Set some things on foo
* foo.ProcessTests(); * foo.ProcessSteps();
* foo.Finalize(); * foo.Finalize();
*
* \sa Initialize(), Finalize(), Part, PartInfo, SetTest()
*/ */
int ProcessTests(); int ProcessSteps();
/* /*
* A utility function that returns the nightly time * A utility function that returns the nightly time