summaryrefslogtreecommitdiffstats
path: root/Source/cmCreateTestSourceList.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmCreateTestSourceList.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmCreateTestSourceList.h')
-rw-r--r--Source/cmCreateTestSourceList.h14
1 files changed, 10 insertions, 4 deletions
diff --git a/Source/cmCreateTestSourceList.h b/Source/cmCreateTestSourceList.h
index 81b9a08..f85dc6b 100644
--- a/Source/cmCreateTestSourceList.h
+++ b/Source/cmCreateTestSourceList.h
@@ -67,10 +67,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "CREATE_TEST_SOURCELIST(SourceListName DriverName test1 test2 test3 "
- "EXTRA_INCLUDE include.h FUNCTION function) The list of source files "
- "needed to build the testdriver will be in SourceListName. "
- "DriverName is the name of the test driver program. The rest of "
+ " 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 testdriver 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 "
"; 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 "