summaryrefslogtreecommitdiffstats
path: root/Source/cmFindProgramCommand.h
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2001-11-26 23:24:47 (GMT)
committerBill Hoffman <bill.hoffman@kitware.com>2001-11-26 23:24:47 (GMT)
commit3e24edcd04234c20a5c3045a7af9ff482fd61a45 (patch)
tree8b42271abfc9a7b04bdd27ecf6d678bb8672c0ad /Source/cmFindProgramCommand.h
parentb170d21c9893c33b44d34ed0dedc81de1baec039 (diff)
downloadCMake-3e24edcd04234c20a5c3045a7af9ff482fd61a45.zip
CMake-3e24edcd04234c20a5c3045a7af9ff482fd61a45.tar.gz
CMake-3e24edcd04234c20a5c3045a7af9ff482fd61a45.tar.bz2
ENH: add possibility to add doc strings to varibles created by find type commands
Diffstat (limited to 'Source/cmFindProgramCommand.h')
-rw-r--r--Source/cmFindProgramCommand.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/Source/cmFindProgramCommand.h b/Source/cmFindProgramCommand.h
index 060fb10..b270199 100644
--- a/Source/cmFindProgramCommand.h
+++ b/Source/cmFindProgramCommand.h
@@ -94,7 +94,11 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "FIND_PROGRAM(NAME executable1 extrapath extrapath ...)";
+ "FIND_PROGRAM(NAME executable1 extrapath extrapath ... [DOC helpstring]) "
+ "Find the executable in the system PATH or in any extra paths specified in the command."
+ "A cache entry called NAME is created to store the result. NOTFOUND is the value"
+ " used if the program was not found. If DOC is specified the next argument is the "
+ "documentation string for the cache entry NAME.";
}
cmTypeMacro(cmFindProgramCommand, cmCommand);