diff options
Diffstat (limited to 'Source/cmSetCommand.h')
| -rw-r--r-- | Source/cmSetCommand.h | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index 73d7f0f..48b0642 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -65,25 +65,26 @@ 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 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" + " set(<variable> <value> [CACHE <type> <docstring> [FORCE]])\n" + "Within CMake sets <variable> to the value <value>. <value> is expanded" + " before <variable> is set to it. If CACHE is present, then the " + "<variable> is put in the cache. <type> and <docstring> are then " + "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 " - "variable, then this always writes into the current makefile. The " + "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 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 semicolon separated list of values.\n" - "VAR can be an environment variable such as:\n" + " set(<variable> <value1> ... <valueN>)\n" + "In this case <variable> is set to a semicolon separated list of " + "values.\n" + "<variable> can be an environment variable such as:\n" " set( ENV{PATH} /home/martink )\n" "in which case the environment variable will be set."; } |