summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>2016-06-21 00:43:42 (GMT)
committerBrad King <brad.king@kitware.com>2016-07-05 15:19:00 (GMT)
commit30c5f94c5bbf1a5cd07858a9c037442f41b65d73 (patch)
tree4e772f0ef36f82a857ae723be4a31d14c75256d4
parent7c87ab755c96ad3f3fc6288d23c02cd0f4898785 (diff)
downloadCMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.zip
CMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.tar.gz
CMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.tar.bz2
cmCTest: Rename "ProcessTests()" to "ProcessSteps()" and improve doxygen
-rw-r--r--Source/cmCTest.cxx4
-rw-r--r--Source/cmCTest.h13
2 files changed, 11 insertions, 6 deletions
diff --git a/Source/cmCTest.cxx b/Source/cmCTest.cxx
index 4508f13..fc218c9 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 f42a274..5c34a94 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