summaryrefslogtreecommitdiffstats
path: root/Source/cmFindFileCommand.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/cmFindFileCommand.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/cmFindFileCommand.h')
-rw-r--r--Source/cmFindFileCommand.h21
1 files changed, 10 insertions, 11 deletions
diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h
index ebf7144..78e8666 100644
--- a/Source/cmFindFileCommand.h
+++ b/Source/cmFindFileCommand.h
@@ -61,7 +61,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Find a file.";
+ return "Find the full path to a file.";
}
/**
@@ -70,16 +70,15 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "FIND_FILE(NAME file extrapath extrapath ... [DOC docstring])"
- "Find a file in the system PATH or in any extra paths specified in the command."
- "A cache entry called NAME is created to store the result. "
- " NAME-NOTFOUND is the value used if the file was not found. "
- "As long as NOTFOUND is the value each time cmake will continue to "
- "try and find the file each time it is run. "
- " If DOC is specified the next argument is the "
- "documentation string for the cache entry NAME. Since Executables, "
- "can have different extensions on different platforms, FIND_PROGRAM,"
- " should be used instead of FIND_FILE when looking for and executable.";
+ " FIND_FILE(VAR fileName path1 path2 ... [DOC docstring])\n"
+ "If the file is found, then VAR is set to the path where it was found. "
+ "A cache entry named by VAR is created to "
+ "store the result. VAR-NOTFOUND is the value used if the file 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. Since Executables "
+ "can have different extensions on different platforms, FIND_PROGRAM "
+ "should be used instead of FIND_FILE when looking for and executable.";
}
cmTypeMacro(cmFindFileCommand, cmCommand);