summaryrefslogtreecommitdiffstats
path: root/Source/cmVariableRequiresCommand.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/cmVariableRequiresCommand.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/cmVariableRequiresCommand.h')
-rw-r--r--Source/cmVariableRequiresCommand.h13
1 files changed, 7 insertions, 6 deletions
diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h
index 896cfe2..0e6f46c 100644
--- a/Source/cmVariableRequiresCommand.h
+++ b/Source/cmVariableRequiresCommand.h
@@ -53,7 +53,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Display an error message .";
+ return "Assert satisfaction of an option's required variables.";
}
/**
@@ -62,16 +62,17 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE "
- "REQUIRED_VARIABLE1 REQUIRED_VARIABLE2 ...) "
+ " VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE\n"
+ " REQUIRED_VARIABLE1\n"
+ " REQUIRED_VARIABLE2 ...)\n"
"The first argument (TEST_VARIABLE) is the name of the variable to be "
"tested, if that variable is false nothing else is done. If "
"TEST_VARIABLE is true, then "
"the next arguemnt (RESULT_VARIABLE) is a vairable that is set to true "
- "if all the "
- "required variables are set."
+ "if all the required variables are set."
"The rest of the arguments are variables that must be true or not "
- "set to NOTFOUND to avoid an error. ";
+ "set to NOTFOUND to avoid an error. If any are not true, an error "
+ "is reported.";
}
cmTypeMacro(cmVariableRequiresCommand, cmCommand);