From b7246860edb1814d2b2e7f3d3a627d63e3ba2523 Mon Sep 17 00:00:00 2001 From: Yannick Warnier Date: Wed, 15 Jul 2020 10:07:12 +0200 Subject: [PATCH] Minor - Add code documentation --- main/inc/lib/display.lib.php | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/main/inc/lib/display.lib.php b/main/inc/lib/display.lib.php index 4de0a952cc..d9a0b861cb 100755 --- a/main/inc/lib/display.lib.php +++ b/main/inc/lib/display.lib.php @@ -816,12 +816,15 @@ class Display } /** - * This public function returns the htmlcode for an icon. + * This public function returns the HTML code for an icon. * - * @param string The filename of the file (in the main/img/ folder - * @param string The alt text (probably a language variable) - * @param array Additional attributes (for instance height, width, onclick, ...) - * @param int The wanted width of the icon (to be looked for in the corresponding img/icons/ folder) + * @param string $image The filename of the file (in the main/img/ folder + * @param string $alt_text The alt text (probably a language variable) + * @param array $additional_attributes Additional attributes (for instance height, width, onclick, ...) + * @param int $size The wanted width of the icon (to be looked for in the corresponding img/icons/ folder) + * @param bool $show_text Whether to show the text next (usually under) the icon + * @param bool $return_only_path Whether we only want the path to the icon or the whole HTML tag + * @param bool $loadThemeIcon Whether we want to allow an overloaded theme icon, if it exists, to replace the default icon * * @return string An HTML string of the right tag * @@ -925,7 +928,7 @@ class Display } /** - * Returns the htmlcode for an image. + * Returns the HTML code for an image. * * @param string $image_path the filename of the file (in the main/img/ folder * @param string $alt_text the alt text (probably a language variable)