diff options
author | Brad King <brad.king@kitware.com> | 2003-11-13 18:51:18 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2003-11-13 18:51:18 (GMT) |
commit | 070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2 (patch) | |
tree | c5bd351a06aeac819cf9b94a5c3a8b6a43c27642 /Source/cmFindPathCommand.h | |
parent | a65fd59c1364a26164fd27559d3089a211745a42 (diff) | |
download | CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.zip CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.tar.gz CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.tar.bz2 |
ENH: Documentation improvements.
Diffstat (limited to 'Source/cmFindPathCommand.h')
-rw-r--r-- | Source/cmFindPathCommand.h | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/Source/cmFindPathCommand.h b/Source/cmFindPathCommand.h index ce8a28f..34d91a4 100644 --- a/Source/cmFindPathCommand.h +++ b/Source/cmFindPathCommand.h @@ -69,13 +69,14 @@ public: virtual const char* GetFullDocumentation() { return - " 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."; + " FIND_PATH(<VAR> fileName path1 [path2 ...]\n" + " [DOC \"docstring\"])\n" + "Find the directory containing a file named by fileName. Paths " + "are searched in the order specified. A cache entry named by " + "<VAR> is created to store the result. If the file is not " + "found, the result will be <VAR>-NOTFOUND. If DOC is specified " + "then the next argument is treated as a documentation string for " + "the cache entry <VAR>.\n"; } cmTypeMacro(cmFindPathCommand, cmCommand); |