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/cmFindFileCommand.h | |
parent | a65fd59c1364a26164fd27559d3089a211745a42 (diff) | |
download | CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.zip CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.tar.gz CMake-070fa61ff4fba9d154d35d2d7e33ee3d8fc0eed2.tar.bz2 |
ENH: Documentation improvements.
Diffstat (limited to 'Source/cmFindFileCommand.h')
-rw-r--r-- | Source/cmFindFileCommand.h | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h index c1cfdc0..800cf0c 100644 --- a/Source/cmFindFileCommand.h +++ b/Source/cmFindFileCommand.h @@ -69,15 +69,16 @@ public: virtual const char* GetFullDocumentation() { return - " 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."; + " FIND_FILE(<VAR> fileName path1 [path2 ...]\n" + " [DOC \"docstring\"])\n" + "Find the full path to 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>. Note that since executables can have " + "different extensions on different platforms, FIND_PROGRAM " + "should be used instead of FIND_FILE when looking for them."; } cmTypeMacro(cmFindFileCommand, cmCommand); |