summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2007-01-04 09:58:55 +0000
committerDries Buytaert <dries@buytaert.net>2007-01-04 09:58:55 +0000
commit5190678d730333d6a979237165e1cfc53ca82554 (patch)
tree90055b205a94b5ee8978938e24dd322a977e85a9
parentaf38c1c03218e70b4b772787a361879faf176528 (diff)
downloadbrdo-5190678d730333d6a979237165e1cfc53ca82554.tar.gz
brdo-5190678d730333d6a979237165e1cfc53ca82554.tar.bz2
- Patch #100563 by m3avrck: improved phpDoc of drupal_add_css.
-rw-r--r--includes/common.inc16
1 files changed, 13 insertions, 3 deletions
diff --git a/includes/common.inc b/includes/common.inc
index ef285ff66..090825f3e 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -1385,13 +1385,23 @@ function drupal_add_link($attributes) {
* Adds a CSS file to the stylesheet queue.
*
* @param $path
- * (optional) The path to the CSS file relative to the base_path(), e.g., /modules/devel/devel.css.
+ * (optional) The path to the CSS file relative to the base_path(), e.g.,
+ * /modules/devel/devel.css.
* @param $type
- * (optional) The type of stylesheet that is being added. Types are: module or theme.
+ * (optional) The type of stylesheet that is being added. Types are: module
+ * or theme.
* @param $media
* (optional) The media type for the stylesheet, e.g., all, print, screen.
* @param $preprocess
- * (optional) Should this CSS file be aggregated and compressed if admin has enabled this feature?
+ * (optional) Should this CSS file be aggregated and compressed if admin has
+ * enabled this feature? Rules for preprocessing CSS files:
+ * - CSS files that style content should be preprocessed. This applies to
+ * both modules and themes that include additional CSS files.
+ * - Theme CSS files that are needed on just about every page should be
+ * preprocessed.
+ * - Styles used on only a few pages should not be preprocessed. The extra
+ * overhead for a small, extra stylesheet is nothing compared to having
+ * to download a completely separate preprocessed file.
* @return
* An array of CSS files.
*/