summaryrefslogtreecommitdiffstats
path: root/Source/cmVariableRequiresCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2007-01-24 18:45:42 (GMT)
committerBrad King <brad.king@kitware.com>2007-01-24 18:45:42 (GMT)
commitf71ad851d81649c59a8f4724d72ba4c935cdefce (patch)
tree0f99fc5c4ea9ecd94a2fa0b7ab222373b5ee4004 /Source/cmVariableRequiresCommand.h
parent03a46e03810ea22c357033bd83508c47766592d6 (diff)
downloadCMake-f71ad851d81649c59a8f4724d72ba4c935cdefce.zip
CMake-f71ad851d81649c59a8f4724d72ba4c935cdefce.tar.gz
CMake-f71ad851d81649c59a8f4724d72ba4c935cdefce.tar.bz2
ENH: Patch from Alex to make deprecated command documentation more consistent.
Diffstat (limited to 'Source/cmVariableRequiresCommand.h')
-rw-r--r--Source/cmVariableRequiresCommand.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h
index 28ef7bd..7de3933 100644
--- a/Source/cmVariableRequiresCommand.h
+++ b/Source/cmVariableRequiresCommand.h
@@ -50,7 +50,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Assert satisfaction of an option's required variables.";
+ return "Deprecated. Use the IF() command instead.";
}
/**
@@ -59,6 +59,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
+ "Assert satisfaction of an option's required variables.\n"
" VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE\n"
" REQUIRED_VARIABLE1\n"
" REQUIRED_VARIABLE2 ...)\n"