summaryrefslogtreecommitdiff
path: root/Source/cmTryCompileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
committerBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmTryCompileCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadcmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmTryCompileCommand.h')
-rw-r--r--Source/cmTryCompileCommand.h16
1 files changed, 9 insertions, 7 deletions
diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h
index dd1a71a3b2..ca99b7ea37 100644
--- a/Source/cmTryCompileCommand.h
+++ b/Source/cmTryCompileCommand.h
@@ -52,7 +52,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Try compiling some code";
+ return "Try compiling some code.";
}
/**
@@ -75,14 +75,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "TRY_COMPILE(RESULT_VAR bindir srcdir projectName <CMAKE_FLAGS <Flags>>)\n"
- "Try compiling a program. Return the success or failure in RESULT_VAR "
+ " TRY_COMPILE(RESULT_VAR bindir srcdir\n"
+ " projectName <CMAKE_FLAGS <Flags>>)\n"
+ "Try compiling a program. Return the success or failure in RESULT_VAR. "
"If <target name> is specified then build just that target "
"otherwise the all or ALL_BUILD target is built.\n"
- "TRY_COMPILE(RESULT_VAR bindir srcfile\n"
- " <CMAKE_FLAGS <Flags>> <COMPILE_DEFINITIONS <flags> ...>)\n"
- "Try compiling a srcfile. Return the success or failure in RESULT_VAR. "
- "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. The "
+ " TRY_COMPILE(RESULT_VAR bindir srcfile\n"
+ " <CMAKE_FLAGS <Flags>>\n"
+ " <COMPILE_DEFINITIONS <flags> ...>)\n"
+ "Try compiling a srcfile. Return the success or failure in RESULT_VAR. "
+ "CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to cmake. The "
"COMPILE_DEFINITIONS are -Ddefinition that will be passed to the "
"compile line. If srcfile is specified the files in bindir/CMakeTmp "
"are cleaned.";