summaryrefslogtreecommitdiff
path: root/Source/cmIncludeCommand.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/cmIncludeCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadcmake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmIncludeCommand.h')
-rw-r--r--Source/cmIncludeCommand.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h
index b1159dfb81..7950e807a4 100644
--- a/Source/cmIncludeCommand.h
+++ b/Source/cmIncludeCommand.h
@@ -61,7 +61,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Basically identical to a C #include \"something\" command.";
+ return "Read CMake listfile code from the given file.";
}
/**
@@ -70,8 +70,11 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "INCLUDE(file1 [OPTIONAL])\nIf OPTIONAL is present, then do not complain "
- "if the file does not exist.";
+ " INCLUDE(file1 [OPTIONAL])\n"
+ "Reads CMake listfile code from the given file. Commands in the file "
+ "are processed immediately as if they were written in place of the "
+ "INCLUDE command. If OPTIONAL is present, then no error "
+ "is raised if the file does not exist.";
}
cmTypeMacro(cmIncludeCommand, cmCommand);