summaryrefslogtreecommitdiff
path: root/Source/cmTryRunCommand.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/cmTryRunCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadcmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmTryRunCommand.h')
-rw-r--r--Source/cmTryRunCommand.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/Source/cmTryRunCommand.h b/Source/cmTryRunCommand.h
index ddd2212283..e8d20c551e 100644
--- a/Source/cmTryRunCommand.h
+++ b/Source/cmTryRunCommand.h
@@ -55,17 +55,19 @@ public:
return "Try compiling and then running some code.";
}
-
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
- "TRY_RUN(RUN_RESULT_VAR COMPILE_RESULT_VAR bindir srcfile <CMAKE_FLAGS <Flags>> <COMPILE_DEFINITIONS <flags>> <ARGUMENTS <arg1> <arg2>...>)\n"
- "Try compiling a srcfile. Return the success or failure in "
- "COMPILE_RESULT_VAR. Then if the compile succeeded, run the "
- "executable and return the result in RUN_RESULT_VAR. ";
+ " TRY_RUN(RUN_RESULT_VAR COMPILE_RESULT_VAR\n"
+ " bindir srcfile <CMAKE_FLAGS <Flags>>\n"
+ " <COMPILE_DEFINITIONS <flags>>\n"
+ " <ARGUMENTS <arg1> <arg2>...>)\n"
+ "Try compiling a srcfile. Return the success or failure in "
+ "COMPILE_RESULT_VAR. Then if the compile succeeded, run the "
+ "executable and return the result in RUN_RESULT_VAR.";
}
cmTypeMacro(cmTryRunCommand, cmCommand);