Parcourir la source

ENH: Added CACHE entry types to documentation string.

Brad King il y a 23 ans
Parent
commit
a56ddb5823
1 fichiers modifiés avec 12 ajouts et 6 suppressions
  1. 12 6
      Source/cmSetCommand.h

+ 12 - 6
Source/cmSetCommand.h

@@ -70,12 +70,18 @@ public:
       "  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"
+      "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"
       "  SET(VAR VALUE1 ... VALUEN).\n"
       "In this case VAR is set to a ; separated list of values.";
     }