From a5d5c6aa4b3eaccb879302cbb868d09a3e5281ff Mon Sep 17 00:00:00 2001
From: Steven Wittens <steven@10.no-reply.drupal.org>
Date: Tue, 12 Dec 2006 06:16:33 +0000
Subject: #102602: Even more documentation for constants (webchick)

---
 includes/bootstrap.inc | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'includes')

diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index b640e5c68..7ce39c49c 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -1,4 +1,4 @@
-<?php
+_<?php
 // $Id$
 
 /**
@@ -6,11 +6,32 @@
  * Functions that need to be loaded on every Drupal request.
  */
 
+/**
+ * Indicates that the item should never be removed unless explicitly told to
+ * using cache_clear_all() with a cache ID.
+ */
 define('CACHE_PERMANENT', 0);
+
+/**
+ * Indicates that the item should be removed at the next general cache wipe.
+ */
 define('CACHE_TEMPORARY', -1);
 
+/**
+ * Indicates that page caching is disabled.
+ */
 define('CACHE_DISABLED', 0);
+
+/**
+ * Indicates that page caching is enabled, using "normal" mode.
+ */
 define('CACHE_NORMAL', 1);
+
+/**
+ * Indicates that page caching is using "aggressive" mode. This bypasses
+ * loading any modules for additional speed, which may break functionality in
+ * modules that expect to be run on each page load.
+ */
 define('CACHE_AGGRESSIVE', 2);
 
 /**
-- 
cgit v1.2.3