summaryrefslogtreecommitdiffstats
path: root/Source/cmCreateTestSourceList.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 17:23:40 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmCreateTestSourceList.h
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadCMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.zip
CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz
CMake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.bz2
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmCreateTestSourceList.h')
-rw-r--r--Source/cmCreateTestSourceList.h40
1 files changed, 0 insertions, 40 deletions
diff --git a/Source/cmCreateTestSourceList.h b/Source/cmCreateTestSourceList.h
index b9c6341..8b1e4de 100644
--- a/Source/cmCreateTestSourceList.h
+++ b/Source/cmCreateTestSourceList.h
@@ -42,46 +42,6 @@ public:
*/
virtual const char* GetName() const {return "create_test_sourcelist";}
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Create a test driver and source list for building test programs.";
- }
-
- /**
- * More documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " create_test_sourcelist(sourceListName driverName\n"
- " test1 test2 test3\n"
- " EXTRA_INCLUDE include.h\n"
- " FUNCTION function)\n"
- "A test driver is a program that links together many small tests into "
- "a single executable. This is useful when building static executables "
- "with large libraries to shrink the total required size. "
- "The list of source files "
- "needed to build the test driver will be in sourceListName. "
- "DriverName is the name of the test driver program. The rest of "
- "the arguments consist of a list of test source files, can be "
- "semicolon separated. Each test source file should have a function in "
- "it that is the same name as the file with no extension (foo.cxx "
- "should have int foo(int, char*[]);) DriverName will be able to "
- "call each of the "
- "tests by name on the command line. If EXTRA_INCLUDE is specified, "
- "then the next argument is included into the generated file. If "
- "FUNCTION is specified, then the next argument is taken as a function "
- "name that is passed a pointer to ac and av. This can be used to add "
- "extra command line processing to each test. The cmake variable "
- "CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be "
- "placed directly before calling the test main function. "
- "CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be "
- "placed directly after the call to the test main function.";
- }
-
cmTypeMacro(cmCreateTestSourceList, cmCommand);
};