Merge "mediawiki.searchSuggest: Show full article title as a tooltip for each suggestion"
[lhc/web/wiklou.git] / includes / media / MediaHandler.php
index e4caf35..f131af4 100644 (file)
@@ -495,7 +495,7 @@ abstract class MediaHandler {
         * This is used by the media handlers that use the FormatMetadata class
         *
         * @param array $metadataArray Metadata array
-        * @return array for use displaying metadata.
+        * @return array Array for use displaying metadata.
         */
        function formatMetadataHelper( $metadataArray ) {
                $result = array(
@@ -523,7 +523,7 @@ abstract class MediaHandler {
         * Get a list of metadata items which should be displayed when
         * the metadata table is collapsed.
         *
-        * @return array of strings
+        * @return array Array of strings
         */
        protected function visibleMetadataFields() {
                return FormatMetadata::getVisibleFields();
@@ -573,7 +573,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * Used instead of getLongDesc if there is no handler registered for file.
+        * Short description. Shown on Special:Search results.
         *
         * @param File $file
         * @return string
@@ -585,7 +585,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * Short description. Shown on Special:Search results.
+        * Long description. Shown under image on image description page surounded by ().
         *
         * @param File $file
         * @return string
@@ -598,7 +598,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * Long description. Shown under image on image description page surounded by ().
+        * Used instead of getShortDesc if there is no handler registered for file.
         *
         * @param File $file
         * @return string
@@ -610,7 +610,7 @@ abstract class MediaHandler {
        }
 
        /**
-        * Used instead of getShortDesc if there is no handler registered for file.
+        * Used instead of getLongDesc if there is no handler registered for file.
         *
         * @param File $file
         * @return string
@@ -644,7 +644,7 @@ abstract class MediaHandler {
         * Shown in file history box on image description page.
         *
         * @param File $file
-        * @return String Dimensions
+        * @return string Dimensions
         */
        function getDimensionsString( $file ) {
                return '';
@@ -776,7 +776,7 @@ abstract class MediaHandler {
         * Get list of languages file can be viewed in.
         *
         * @param File $file
-        * @return Array Array of language codes, or empty array if unsupported.
+        * @return string[] Array of language codes, or empty array if unsupported.
         * @since 1.23
         */
        public function getAvailableLanguages( File $file ) {
@@ -792,7 +792,7 @@ abstract class MediaHandler {
         * type do not support alternative language renderings.
         *
         * @param File $file
-        * @return String language code or null if multi-language not supported for filetype.
+        * @return string|null Language code or null if multi-language not supported for filetype.
         * @since 1.23
         */
        public function getDefaultRenderLanguage( File $file ) {