Make some array type hints more specific
authorThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Wed, 22 May 2019 11:37:12 +0000 (13:37 +0200)
committerThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Wed, 22 May 2019 11:37:12 +0000 (13:37 +0200)
Change-Id: Ia9ed6fa851316baa47e73d9a5988a863d15f298c

includes/changes/ChangesList.php
includes/media/BitmapHandler.php
includes/resourceloader/ResourceLoaderModule.php
includes/specials/forms/PreferencesFormOOUI.php
includes/watcheditem/WatchedItemQueryService.php

index 6f6887b..0c1e5cb 100644 (file)
@@ -192,7 +192,7 @@ class ChangesList extends ContextSource {
         * @param RecentChange|RCCacheEntry $rc
         * @param string|bool $watched Optionally timestamp for adding watched class
         *
-        * @return array of classes
+        * @return string[] List of CSS class names
         */
        protected function getHTMLClasses( $rc, $watched ) {
                $classes = [ self::CSS_CLASS_PREFIX . 'line' ];
index 2d1c3b2..e07b166 100644 (file)
@@ -110,7 +110,7 @@ class BitmapHandler extends TransformationalImageHandler {
         * Get ImageMagick subsampling factors for the target JPEG pixel format.
         *
         * @param string $pixelFormat one of 'yuv444', 'yuv422', 'yuv420'
-        * @return array of string keys
+        * @return string[] List of sampling factors
         */
        protected function imageMagickSubsampling( $pixelFormat ) {
                switch ( $pixelFormat ) {
index aca5c73..53ed133 100644 (file)
@@ -182,7 +182,7 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
        /**
         * Takes named templates by the module and returns an array mapping.
         *
-        * @return array of templates mapping template alias to content
+        * @return string[] Array of templates mapping template alias to content
         */
        public function getTemplates() {
                // Stub, override expected.
index 8358cd2..9b86812 100644 (file)
@@ -195,7 +195,7 @@ class PreferencesFormOOUI extends OOUIHTMLForm {
 
        /**
         * Get the keys of each top level preference section.
-        * @return array of section keys
+        * @return string[] List of section keys
         */
        function getPreferenceSections() {
                return array_keys( array_filter( $this->mFieldTree, 'is_array' ) );
index 30e3cbe..b134bfe 100644 (file)
@@ -132,7 +132,7 @@ class WatchedItemQueryService {
         *                                 id fields ('rc_cur_id', 'rc_this_oldid', 'rc_last_oldid')
         *                                 if false (default)
         * @param array|null &$startFrom Continuation value: [ string $rcTimestamp, int $rcId ]
-        * @return array of pairs ( WatchedItem $watchedItem, string[] $recentChangeInfo ),
+        * @return array[] Array of pairs ( WatchedItem $watchedItem, string[] $recentChangeInfo ),
         *         where $recentChangeInfo contains the following keys:
         *         - 'rc_id',
         *         - 'rc_namespace',