summaryrefslogtreecommitdiff
path: root/Source/cmFindLibraryCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
committerBrad King <brad.king@kitware.com>2003-02-14 18:47:16 -0500
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmFindLibraryCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadcmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmFindLibraryCommand.h')
-rw-r--r--Source/cmFindLibraryCommand.h14
1 files changed, 10 insertions, 4 deletions
diff --git a/Source/cmFindLibraryCommand.h b/Source/cmFindLibraryCommand.h
index 200979d8ef..b146984f8c 100644
--- a/Source/cmFindLibraryCommand.h
+++ b/Source/cmFindLibraryCommand.h
@@ -70,10 +70,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "FIND_LIBRARY(DEFINE_PATH libraryName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [DOC docstring] )\n"
- "If the library is found, then DEFINE_PATH is set to the full path where it was found. "
- "If DOC is specified the next argument is the "
- "documentation string for the cache entry NAME.";
+ " FIND_LIBRARY(VAR libraryName\n"
+ " [NAMES name1 name2 ...]\n"
+ " [PATHS path1 path2 ...]\n"
+ " [DOC helpstring])\n"
+ "Find the library by looking in paths specified in the command. "
+ "A cache entry named by VAR is created to "
+ "store the result. VAR-NOTFOUND is the value used if the library 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(cmFindLibraryCommand, cmCommand);