summaryrefslogtreecommitdiffstats
path: root/Source/cmLoadCommandCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmLoadCommandCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmLoadCommandCommand.h')
-rw-r--r--Source/cmLoadCommandCommand.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/Source/cmLoadCommandCommand.h b/Source/cmLoadCommandCommand.h
index 4a60e32..17de45a 100644
--- a/Source/cmLoadCommandCommand.h
+++ b/Source/cmLoadCommandCommand.h
@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Load a command into a running CMake";
+ return "Load a command into a running CMake.";
}
/**
@@ -67,7 +67,11 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "LOAD_COMMAND(command)\n";
+ " LOAD_COMMAND(COMMAND_NAME <loc1> [loc2 ...])\n"
+ "The given locations are searched for a library whose name is "
+ "cmCOMMAND_NAME. If found, it is loaded as a module and the command "
+ "is added to the set of available CMake commands. Usually, TRY_COMPILE "
+ "is used before this command to compile the module.";
}
cmTypeMacro(cmLoadCommandCommand, cmCommand);