diff options
author | Dries Buytaert <dries@buytaert.net> | 2010-04-13 15:23:03 +0000 |
---|---|---|
committer | Dries Buytaert <dries@buytaert.net> | 2010-04-13 15:23:03 +0000 |
commit | 3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d (patch) | |
tree | 4bd9c67db94feb06249cc2727dd3a5e935f58e12 /modules/file/file.module | |
parent | f8e14898d636ceae44a9980105da903f57d2deef (diff) | |
download | brdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.gz brdo-3c3cee28b94eb0c14f6958e1e6440bba15bc9a7d.tar.bz2 |
- Patch #716496 by JohnAlbin: documentation updates for theme functions.
Diffstat (limited to 'modules/file/file.module')
-rw-r--r-- | modules/file/file.module | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/modules/file/file.module b/modules/file/file.module index b3153e647..b925d7c2e 100644 --- a/modules/file/file.module +++ b/modules/file/file.module @@ -607,7 +607,13 @@ function file_managed_file_save_upload($element) { } /** - * Theme a managed file element. + * Returns HTML for a managed file element. + * + * @param $variables + * An associative array containing: + * - element: A render element representing the file. + * + * @ingroup themeable */ function theme_file_managed_file($variables) { $element = $variables['element']; @@ -621,11 +627,13 @@ function theme_file_managed_file($variables) { } /** - * Output a link to a file. + * Returns HTML for a link to a file. * * @param $variables * An associative array containing: * - file: A file object to which the link will be created. + * + * @ingroup themeable */ function theme_file_link($variables) { $file = $variables['file']; @@ -654,11 +662,13 @@ function theme_file_link($variables) { } /** - * Return an image with an appropriate icon for the given file. + * Returns HTML for an image with an appropriate icon for the given file. * * @param $variables * An associative array containing: * - file: A file object for which to make an icon. + * + * @ingroup themeable */ function theme_file_icon($variables) { $file = $variables['file']; |