diff options
author | Brad King <brad.king@kitware.com> | 2003-02-14 18:47:16 -0500 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2003-02-14 18:47:16 -0500 |
commit | a02574158d178615cf8fd642695e5099b6041049 (patch) | |
tree | df9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmFindPathCommand.h | |
parent | dec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff) | |
download | cmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz |
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmFindPathCommand.h')
-rw-r--r-- | Source/cmFindPathCommand.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Source/cmFindPathCommand.h b/Source/cmFindPathCommand.h index d64e02264e..c32ccf12d3 100644 --- a/Source/cmFindPathCommand.h +++ b/Source/cmFindPathCommand.h @@ -61,7 +61,7 @@ public: */ virtual const char* GetTerseDocumentation() { - return "Find a path for a file."; + return "Find the directory containing a file."; } /** @@ -70,10 +70,13 @@ public: virtual const char* GetFullDocumentation() { return - "FIND_PATH(PATH_DEFINE fileName path1 path2 path3...)\n" - "If the file is found, then PATH_DEFINE is set to the path where it was found." - "If DOC is specified the next argument is the " - "documentation string for the cache entry NAME."; + " FIND_PATH(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."; } cmTypeMacro(cmFindPathCommand, cmCommand); |