More return documentation

[lhc/web/wiklou.git] / includes / ImageGallery.php

diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php
index 68a5a20..5a8fb8e 100644 (file)
--- a/includes/ImageGallery.php
+++ b/includes/ImageGallery.php
@@ -75,7 +75,7 @@ class ImageGallery {
        /**
         * Set the caption (as plain text)
         *
-        * @param $caption Caption
+        * @param $caption string Caption
         */
        function setCaption( $caption ) {
                $this->mCaption = htmlspecialchars( $caption );
@@ -168,6 +168,7 @@ class ImageGallery {
 
        /**
         * isEmpty() returns true if the gallery contains no images
+        * @return bool
         */
        function isEmpty() {
                return empty( $this->mImages );
@@ -215,6 +216,7 @@ class ImageGallery {
         * - the additional text provided when adding the image
         * - the size of the image
         *
+        * @return string
         */
        function toHTML() {
                global $wgLang;
@@ -314,7 +316,7 @@ class ImageGallery {
 
                        if( $this->mShowBytes ) {
                                if( $img ) {
-                                       $fileSize = $wgLang->formatSize( $img->getSize() );
+                                       $fileSize = htmlspecialchars( $wgLang->formatSize( $img->getSize() ) );
                                } else {
                                        $fileSize = wfMsgHtml( 'filemissing' );
                                }