diff options
| author | Ken Martin <ken.martin@kitware.com> | 2005-11-17 15:28:35 (GMT) |
|---|---|---|
| committer | Ken Martin <ken.martin@kitware.com> | 2005-11-17 15:28:35 (GMT) |
| commit | 5385811e6057f20ac6c8ef119cb26874e1d95914 (patch) | |
| tree | 30fc26ac179853aa4ea6149b8a2e52a5b4d8b405 /Source/cmSetCommand.h | |
| parent | ef5fe4b256e774e5d318c7b6ff416a52e72624bd (diff) | |
| download | CMake-5385811e6057f20ac6c8ef119cb26874e1d95914.zip CMake-5385811e6057f20ac6c8ef119cb26874e1d95914.tar.gz CMake-5385811e6057f20ac6c8ef119cb26874e1d95914.tar.bz2 | |
STYLE: fix docs
Diffstat (limited to 'Source/cmSetCommand.h')
| -rw-r--r-- | Source/cmSetCommand.h | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index 5253baf..c73968f 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -66,22 +66,23 @@ public: { 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 is used by the CMake GUI to " - "choose a widget with which the user sets a value. The value for TYPE " - "may be one of\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 is used by the CMake GUI " + "to choose a widget with which the user sets a value. The value for " + "TYPE may be one of\n" " FILEPATH = File chooser dialog.\n" " PATH = Directory chooser dialog.\n" " STRING = Arbitrary string.\n" " BOOL = Boolean ON/OFF checkbox.\n" " INTERNAL = No GUI entry (used for persistent variables).\n" "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 by the USER.\n" + "replacing any values existing in the cache. If it is not a cache " + "variable, then this always writes into the current makefile. The " + "FORCE option will overwrite the cache value removing any changes by " + "the user.\n" " SET(VAR VALUE1 ... VALUEN).\n" - "In this case VAR is set to a ; separated list of values.\n" + "In this case VAR is set to a semicolon separated list of values.\n" "VAR can be an environment variable such as:\n" " SET( ENV{PATH} /home/martink )\n" "in which case the environment variable will be set."; |