mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-25 00:59:19 -06:00
Code Issues Packages Projects Releases Wiki Activity

ENH: Documentation improvements.

Browse Source
This commit is contained in:
Brad King
2003-11-13 13:51:18 -05:00
parent a65fd59c13
commit 070fa61ff4
4 changed files with 46 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Source/cmFindFileCommand.h
View File

@@ -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);