summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2014-09-16 22:07:45 (GMT)
committer Jennifer Hodgdon2014-09-16 22:07:45 (GMT)
commit5b99e319cd7614512de69b32974cc96b6f7e98ee (patch)
treee46d31aff3a33e2a6c2ec19598bd07d8650e6b99
parent3bd008b0319c98fad591ab5d175889df8033a519 (diff)
Issue #2314181 by roderik, er.pushpinderrana, hefox: Fix docs for drupal_static7.x
-rw-r--r--includes/bootstrap.inc10
1 files changed, 5 insertions, 5 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 9e9ced2..e15f57b 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -3328,11 +3328,9 @@ function registry_update() {
* @param $default_value
* Optional default value.
* @param $reset
- * TRUE to reset a specific named variable, or all variables if $name is NULL.
- * Resetting every variable should only be used, for example, for running
- * unit tests with a clean environment. Should be used only though via
- * function drupal_static_reset() and the return value should not be used in
- * this case.
+ * TRUE to reset one or all variables(s). This parameter is only used
+ * internally and should not be passed in; use drupal_static_reset() instead.
+ * (This function's return value should not be used when TRUE is passed in.)
*
* @return
* Returns a variable by reference.
@@ -3377,6 +3375,8 @@ function &drupal_static($name, $default_value = NULL, $reset = FALSE) {
*
* @param $name
* Name of the static variable to reset. Omit to reset all variables.
+ * Resetting all variables should only be used, for example, for running unit
+ * tests with a clean environment.
*/
function drupal_static_reset($name = NULL) {
drupal_static($name, NULL, TRUE);