ENH: Added CACHE entry types to documentation string.

This commit is contained in:
Brad King 2003-04-04 10:56:11 -05:00
parent f6e87dc2f6
commit a56ddb5823

View File

@ -70,12 +70,18 @@ public:
" SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n" " SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
"Within CMAKE sets VAR to the value VALUE. VALUE is expanded before VAR " "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. " "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, " "TYPE and DOCSTRING are required. TYPE is used by the CMake GUI to "
"STRING, INTERNAL, or STATIC. If TYPE is INTERNAL, then the " "choose a widget with which the user sets a value. The value for TYPE "
"VALUE is Always written into the cache, replacing any values " "may be one of\n"
"existing in the cache. If it is not a CACHE VAR, then this always " " FILEPATH = File chooser dialog.\n"
"writes into the current makefile. The FORCE option will overwrite" " PATH = Directory chooser dialog.\n"
"the CACHE value removing any changes from the USER.\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" " SET(VAR VALUE1 ... VALUEN).\n"
"In this case VAR is set to a ; separated list of values."; "In this case VAR is set to a ; separated list of values.";
} }