summaryrefslogtreecommitdiffstats
path: root/Source/cmFindProgramCommand.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/cmFindProgramCommand.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/cmFindProgramCommand.h')
-rw-r--r--Source/cmFindProgramCommand.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/Source/cmFindProgramCommand.h b/Source/cmFindProgramCommand.h
index 3c39cb8..99eb49c 100644
--- a/Source/cmFindProgramCommand.h
+++ b/Source/cmFindProgramCommand.h
@@ -70,13 +70,19 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "FIND_PROGRAM(DEFINE_NAME executableName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [NO_SYSTEM_PATH] [DOC helpstring]) "
- "Find the executable in the system PATH or in any extra paths specified in the command."
- "A cache entry called DEFILE_NAME is created to store the result. DEFILE_NAME-NOTFOUND is the value"
- " used if the program was not found. CMake will continue to look as long as the value "
- "is NOTFOUND If DOC is specified the next argument is the "
- "documentation string for the cache entry NAME."
- "If NO_SYSTEM_PATH is specified the contents of system PATH is not used";
+ " FIND_PROGRAM(VAR executableName\n"
+ " [NAMES name1 name2 ...]\n"
+ " [PATHS path1 path2 ...]\n"
+ " [NO_SYSTEM_PATH]\n"
+ " [DOC helpstring])\n"
+ "Find the executable in the system PATH or in any extra paths "
+ "specified in the command. A cache entry named by VAR is created to "
+ "store the result. VAR-NOTFOUND is the value used if the program was "
+ "not found. CMake will continue to look as long as the value "
+ "is not found. If DOC is specified the next argument is the "
+ "documentation string for the cache entry VAR. "
+ "If NO_SYSTEM_PATH is specified the contents of system PATH are not "
+ "used.";
}
cmTypeMacro(cmFindProgramCommand, cmCommand);