aboutsummaryrefslogtreecommitdiff
path: root/views/default/graphics/icon.php
diff options
context:
space:
mode:
Diffstat (limited to 'views/default/graphics/icon.php')
-rw-r--r--views/default/graphics/icon.php6
1 files changed, 6 insertions, 0 deletions
diff --git a/views/default/graphics/icon.php b/views/default/graphics/icon.php
index bc7c36e71..6b92a510d 100644
--- a/views/default/graphics/icon.php
+++ b/views/default/graphics/icon.php
@@ -6,6 +6,12 @@
* @subpackage Core
* @author Curverider Ltd
* @link http://elgg.org/
+ *
+ * @uses $vars['entity'] The entity the icon represents - uses getIcon() method
+ * @uses $vars['js'] Any JavaScript to add to img tag
+ * @uses $vars['size'] topbar, tiny, small, medium (default), large, master
+ * @uses $vars['link'] Optional link for the image
+ * @uses $vars['align'] Align attribute of the img tag
*/
$entity = $vars['entity'];