mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

ENH: Cleaned up documentation and formatted it for use by cmDocumentation.

Browse Source
This commit is contained in:
Brad King
2003-02-14 18:47:16 -05:00
parent dec0b51066
commit a02574158d
75 changed files with 612 additions and 365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Source/cmVariableRequiresCommand.h
View File

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