summaryrefslogtreecommitdiffstats
path: root/Source/cmSetCommand.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/cmSetCommand.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/cmSetCommand.h')
-rw-r--r--Source/cmSetCommand.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h
index b3b39a8..f93f4dd 100644
--- a/Source/cmSetCommand.h
+++ b/Source/cmSetCommand.h
@@ -58,7 +58,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Set a CMAKE variable to a value";
+ return "Set a CMAKE variable to a given value.";
}
/**
@@ -67,16 +67,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
- "Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR "
- "is set to it. If CACHE is present, then the VAR is put in the cache."
- " TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, STRING, INTERNAL, "
- "or STATIC. If TYPE is INTERNAL, then the "
- " VALUE is Always written into the cache, replacing any values "
+ " SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
+ "Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR "
+ "is set to it. If CACHE is present, then the VAR is put in the cache. "
+ "TYPE and DOCSTRING are required. TYPE may be BOOL, PATH, FILEPATH, "
+ "STRING, INTERNAL, or STATIC. If TYPE is INTERNAL, then the "
+ "VALUE is Always written into the cache, replacing any values "
"existing in the cache. If it is not a CACHE VAR, then this always "
"writes into the current makefile. The FORCE option will overwrite"
"the CACHE value removing any changes from the USER.\n"
- "An optional syntax is SET(VAR VALUE1 ... VALUEN).\n"
+ " SET(VAR VALUE1 ... VALUEN).\n"
"In this case VAR is set to a ; separated list of values.";
}