summaryrefslogtreecommitdiff
path: root/modules/image
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2012-03-06 10:05:19 -0800
committerJennifer Hodgdon <yahgrp@poplarware.com>2012-03-06 10:05:19 -0800
commit261faf0b973d12a2f175c9f5c3363a253dab3643 (patch)
tree050b9de01e533ae77e3a19c10c3b7003876a5cb2 /modules/image
parentdfacba7ffb98e948fa7422291b8ff714865a1a01 (diff)
downloadbrdo-261faf0b973d12a2f175c9f5c3363a253dab3643.tar.gz
brdo-261faf0b973d12a2f175c9f5c3363a253dab3643.tar.bz2
Issue #1444650 by damiankloip: Make documentation of theme_image_style clearer
Diffstat (limited to 'modules/image')
-rw-r--r--modules/image/image.module4
1 files changed, 3 insertions, 1 deletions
diff --git a/modules/image/image.module b/modules/image/image.module
index 35f1068fd..5079cba5b 100644
--- a/modules/image/image.module
+++ b/modules/image/image.module
@@ -1171,7 +1171,9 @@ function image_effect_apply($image, $effect) {
* - style_name: The name of the style to be used to alter the original image.
* - path: The path of the image file relative to the Drupal files directory.
* This function does not work with images outside the files directory nor
- * with remotely hosted images.
+ * with remotely hosted images. This should be in a format such as
+ * 'images/image.jpg', or using a stream wrapper such as
+ * 'public://images/image.jpg'.
* - width: The width of the source image (if known).
* - height: The height of the source image (if known).
* - alt: The alternative text for text-based browsers.