diff options
| author | Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com> | 2016-06-21 00:43:42 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-07-05 15:19:00 (GMT) |
| commit | 30c5f94c5bbf1a5cd07858a9c037442f41b65d73 (patch) | |
| tree | 4e772f0ef36f82a857ae723be4a31d14c75256d4 /Source/cmCTest.h | |
| parent | 7c87ab755c96ad3f3fc6288d23c02cd0f4898785 (diff) | |
| download | CMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.zip CMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.tar.gz CMake-30c5f94c5bbf1a5cd07858a9c037442f41b65d73.tar.bz2 | |
cmCTest: Rename "ProcessTests()" to "ProcessSteps()" and improve doxygen
Diffstat (limited to 'Source/cmCTest.h')
| -rw-r--r-- | Source/cmCTest.h | 13 |
1 files changed, 9 insertions, 4 deletions
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 |