summaryrefslogtreecommitdiffstats
path: root/Source/cmExecProgramCommand.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/cmExecProgramCommand.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/cmExecProgramCommand.h')
-rw-r--r--Source/cmExecProgramCommand.h16
1 files changed, 10 insertions, 6 deletions
diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h
index 560568c..7379000 100644
--- a/Source/cmExecProgramCommand.h
+++ b/Source/cmExecProgramCommand.h
@@ -64,12 +64,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "EXEC_PROGRAM(Executable [Directory to run in] [ARGS arguments to executable] [OUTPUT_VARIABLE var] [RETURN_VALUE var])"
- "The executable is run in the optionally specified Directory. The executable "
- "can include arguments if it is double quoted, but it is better to use the "
- "optional ARGS argument to specify arguments to the program. This is because "
- "cmake will then be able to escape spaces in the Executable path. An optiona "
- "argument OUTPUT_VARIABLE specifies a variable to which the output will be set. "
+ " EXEC_PROGRAM(Executable [directory in which to run]\n"
+ " [ARGS <arguments to executable>]\n"
+ " [OUTPUT_VARIABLE <var>]\n"
+ " [RETURN_VALUE <var>])\n"
+ "The executable is run in the optionally specified Directory. The "
+ "executable can include arguments if it is double quoted, but it is "
+ "better to use the optional ARGS argument to specify arguments to the "
+ "program. This is because cmake will then be able to escape spaces "
+ "in the Executable path. An optional argument OUTPUT_VARIABLE "
+ "specifies a variable in which to store the output. "
"To capture the return value of the execution, use RETURN_VALUE variable. "
"If OUTPUT_VARIABLE is specified, then no output will go to the stdout/stderr "
"of the console running cmake.";