summaryrefslogtreecommitdiffstats
path: root/Source/cmMarkAsAdvancedCommand.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/cmMarkAsAdvancedCommand.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/cmMarkAsAdvancedCommand.h')
-rw-r--r--Source/cmMarkAsAdvancedCommand.h18
1 files changed, 11 insertions, 7 deletions
diff --git a/Source/cmMarkAsAdvancedCommand.h b/Source/cmMarkAsAdvancedCommand.h
index defaf61..c78de7b 100644
--- a/Source/cmMarkAsAdvancedCommand.h
+++ b/Source/cmMarkAsAdvancedCommand.h
@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Mark a cmake variable as advanced.";
+ return "Mark cmake cached variables as advanced.";
}
/**
@@ -67,12 +67,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "MARK_AS_ADVANCED([CLEAR|FORCE]VAR VAR2 VAR... )\n"
- "Mark the named variables as advanced. An advanced variable will not be displayed in"
- " any of the cmake GUIs, unless the show advanced option is on. "
- "If CLEAR is the first argument advanced variables are changed back to unadvanced."
- "If FORCE is the first arguement, then the variable is made advanced."
- "If neither FORCE or CLEAR is specified, new values will be marked as advanced, but if the variable already has an advanced state, it will not be changed.";
+ " MARK_AS_ADVANCED([CLEAR|FORCE] VAR VAR2 VAR...)\n"
+ "Mark the named cached variables as advanced. An advanced variable "
+ "will not be displayed in any of the cmake GUIs unless the show "
+ "advanced option is on. "
+ "If CLEAR is the first argument advanced variables are changed back "
+ "to unadvanced. "
+ "If FORCE is the first arguement, then the variable is made advanced. "
+ "If neither FORCE or CLEAR is specified, new values will be marked as "
+ "advanced, but if the variable already has an advanced/non-advanced "
+ "state, it will not be changed.";
}
cmTypeMacro(cmMarkAsAdvancedCommand, cmCommand);