From: Umherirrender Date: Sun, 7 Jan 2018 10:38:43 +0000 (+0100) Subject: Improve some parameter docs X-Git-Tag: 1.31.0-rc.0~977^2 X-Git-Url: http://git.cyclocoop.org/?a=commitdiff_plain;h=23ef520a1c131bd802454faa33e3c6ae6c071183;p=lhc%2Fweb%2Fwiklou.git Improve some parameter docs Change-Id: I31e983d7ac287158101b18ad95779d83537302a2 --- diff --git a/includes/Feed.php b/includes/Feed.php index 0e715df2ff..92eec0830a 100644 --- a/includes/Feed.php +++ b/includes/Feed.php @@ -153,6 +153,7 @@ class FeedItem { /** * Get the description of this item without any escaping * + * @return string */ public function getDescriptionUnescaped() { return $this->description; diff --git a/includes/Preferences.php b/includes/Preferences.php index 0a41573a21..37de2a55a9 100644 --- a/includes/Preferences.php +++ b/includes/Preferences.php @@ -315,6 +315,7 @@ class Preferences { /** * @param array $formData * @param PreferencesForm $form + * @return Status */ public static function tryUISubmit( $formData, $form ) { $preferencesFactory = self::getDefaultPreferencesFactory(); diff --git a/includes/Revision.php b/includes/Revision.php index 54c6de0b0c..b1440d0a5d 100644 --- a/includes/Revision.php +++ b/includes/Revision.php @@ -65,7 +65,7 @@ class Revision implements IDBAccessObject { } /** - * @param bool|string $wikiId The ID of the target wiki database. Use false for the local wiki. + * @param bool|string $wiki The ID of the target wiki database. Use false for the local wiki. * * @return SqlBlobStore */ diff --git a/includes/Storage/RevisionStore.php b/includes/Storage/RevisionStore.php index 2e953fc15d..09501096d9 100644 --- a/includes/Storage/RevisionStore.php +++ b/includes/Storage/RevisionStore.php @@ -562,6 +562,7 @@ class RevisionStore implements IDBAccessObject, RevisionFactory, RevisionLookup /** * MCR migration note: this replaces Revision::isUnpatrolled * + * @param RevisionRecord $rev * @return int Rcid of the unpatrolled row, zero if there isn't one */ public function isUnpatrolled( RevisionRecord $rev ) { diff --git a/includes/Xml.php b/includes/Xml.php index 0091513125..b20f66ef1c 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -532,8 +532,8 @@ class Xml { * * @param string $list Correctly formatted text (newline delimited) to be * used to generate the options. - * @param array $params Extra parameters - * @param string $params['other'] If set, add an option with this as text and a value of 'other' + * @param array $params Extra parameters: + * - string $params['other'] If set, add an option with this as text and a value of 'other' * @return array Array keys are textual labels, values are internal values */ public static function listDropDownOptions( $list, $params = [] ) { diff --git a/includes/collation/IcuCollation.php b/includes/collation/IcuCollation.php index 23f02de375..36efdb379b 100644 --- a/includes/collation/IcuCollation.php +++ b/includes/collation/IcuCollation.php @@ -492,7 +492,6 @@ class IcuCollation extends Collation { } /** - * @param string $index * @return string * @since 1.16.3 */ diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php index 562819ec4e..409f507969 100644 --- a/includes/libs/objectcache/WANObjectCache.php +++ b/includes/libs/objectcache/WANObjectCache.php @@ -214,6 +214,9 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface { $this->asyncHandler = isset( $params['asyncHandler'] ) ? $params['asyncHandler'] : null; } + /** + * @param LoggerInterface $logger + */ public function setLogger( LoggerInterface $logger ) { $this->logger = $logger; } @@ -1238,7 +1241,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface { * @param string $key * @param bool $versioned * @param float $minTime - * @param mixed $asOf + * @param mixed &$asOf * @return mixed */ protected function getInterimValue( $key, $versioned, $minTime, &$asOf ) { diff --git a/includes/preferences/DefaultPreferencesFactory.php b/includes/preferences/DefaultPreferencesFactory.php index a30acebc63..0391b301a7 100644 --- a/includes/preferences/DefaultPreferencesFactory.php +++ b/includes/preferences/DefaultPreferencesFactory.php @@ -70,6 +70,12 @@ class DefaultPreferencesFactory implements PreferencesFactory { /** @var LinkRenderer */ protected $linkRenderer; + /** + * @param Config $config + * @param Language $contLang + * @param AuthManager $authManager + * @param LinkRenderer $linkRenderer + */ public function __construct( Config $config, Language $contLang, diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php index 63a495a615..e1d4f26c2e 100644 --- a/includes/resourceloader/ResourceLoader.php +++ b/includes/resourceloader/ResourceLoader.php @@ -690,7 +690,6 @@ class ResourceLoader implements LoggerAwareInterface { * * @since 1.28 * @param ResourceLoaderContext $context - * @param string[] $modules List of module names * @return string Hash */ public function makeVersionQuery( ResourceLoaderContext $context ) { diff --git a/includes/shell/Result.php b/includes/shell/Result.php index 1e18210f2b..a105cd12d3 100644 --- a/includes/shell/Result.php +++ b/includes/shell/Result.php @@ -38,6 +38,7 @@ class Result { /** * @param int $exitCode * @param string $stdout + * @param string|null $stderr */ public function __construct( $exitCode, $stdout, $stderr = null ) { $this->exitCode = $exitCode; diff --git a/includes/specialpage/LoginSignupSpecialPage.php b/includes/specialpage/LoginSignupSpecialPage.php index 963840b811..d6ace0afcf 100644 --- a/includes/specialpage/LoginSignupSpecialPage.php +++ b/includes/specialpage/LoginSignupSpecialPage.php @@ -478,7 +478,6 @@ abstract class LoginSignupSpecialPage extends AuthManagerSpecialPage { /** * Replace some globals to make sure the fact that the user has just been logged in is * reflected in the current request. - * @param User $user */ protected function setSessionUserForCurrentRequest() { global $wgUser, $wgLang; diff --git a/includes/watcheditem/WatchedItemStore.php b/includes/watcheditem/WatchedItemStore.php index f29bd479c1..c68d6d7fdf 100644 --- a/includes/watcheditem/WatchedItemStore.php +++ b/includes/watcheditem/WatchedItemStore.php @@ -78,6 +78,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac $this->revisionGetTimestampFromIdCallback = [ 'Revision', 'getTimestampFromId' ]; } + /** + * @param StatsdDataFactoryInterface $stats + */ public function setStatsdDataFactory( StatsdDataFactoryInterface $stats ) { $this->stats = $stats; } @@ -241,6 +244,8 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.31 + * @param User $user + * @return int */ public function countWatchedItems( User $user ) { $dbr = $this->getConnectionRef( DB_REPLICA ); @@ -258,6 +263,8 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param LinkTarget $target + * @return int */ public function countWatchers( LinkTarget $target ) { $dbr = $this->getConnectionRef( DB_REPLICA ); @@ -276,6 +283,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param LinkTarget $target + * @param string|int $threshold + * @return int */ public function countVisitingWatchers( LinkTarget $target, $threshold ) { $dbr = $this->getConnectionRef( DB_REPLICA ); @@ -297,6 +307,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param LinkTarget[] $targets + * @param array $options + * @return array */ public function countWatchersMultiple( array $targets, array $options = [] ) { $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ]; @@ -330,6 +343,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param array $targetsWithVisitThresholds + * @param int|null $minimumWatchers + * @return array */ public function countVisitingWatchersMultiple( array $targetsWithVisitThresholds, @@ -410,6 +426,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget $target + * @return bool */ public function getWatchedItem( User $user, LinkTarget $target ) { if ( $user->isAnon() ) { @@ -427,6 +446,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget $target + * @return bool */ public function loadWatchedItem( User $user, LinkTarget $target ) { // Only loggedin user can have a watchlist @@ -458,6 +480,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param array $options + * @return WatchedItem[] */ public function getWatchedItemsForUser( User $user, array $options = [] ) { $options += [ 'forWrite' => false ]; @@ -499,6 +524,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget $target + * @return bool */ public function isWatched( User $user, LinkTarget $target ) { return (bool)$this->getWatchedItem( $user, $target ); @@ -506,6 +534,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget[] $targets + * @return array */ public function getNotificationTimestampsBatch( User $user, array $targets ) { $timestamps = []; @@ -555,6 +586,8 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget $target */ public function addWatch( User $user, LinkTarget $target ) { $this->addWatchBatchForUser( $user, [ $target ] ); @@ -562,6 +595,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget[] $targets + * @return bool */ public function addWatchBatchForUser( User $user, array $targets ) { if ( $this->readOnlyMode->isReadOnly() ) { @@ -611,6 +647,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param LinkTarget $target + * @return bool */ public function removeWatch( User $user, LinkTarget $target ) { // Only logged in user can have a watchlist @@ -635,6 +674,10 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param string|int $timestamp + * @param LinkTarget[] $targets + * @return bool */ public function setNotificationTimestampsForUser( User $user, $timestamp, array $targets = [] ) { // Only loggedin user can have a watchlist @@ -668,6 +711,10 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $editor + * @param LinkTarget $target + * @param string|int $timestamp + * @return int */ public function updateNotificationTimestamp( User $editor, LinkTarget $target, $timestamp ) { $dbw = $this->getConnectionRef( DB_MASTER ); @@ -724,6 +771,11 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param Title $title + * @param string $force + * @param int $oldid + * @return bool */ public function resetNotificationTimestamp( User $user, Title $title, $force = '', $oldid = 0 ) { // Only loggedin user can have a watchlist @@ -813,6 +865,9 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param User $user + * @param int|null $unreadLimit + * @return int|bool */ public function countUnreadNotifications( User $user, $unreadLimit = null ) { $queryOptions = []; @@ -846,6 +901,8 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param LinkTarget $oldTarget + * @param LinkTarget $newTarget */ public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget ) { $oldTarget = Title::newFromLinkTarget( $oldTarget ); @@ -857,6 +914,8 @@ class WatchedItemStore implements WatchedItemStoreInterface, StatsdAwareInterfac /** * @since 1.27 + * @param LinkTarget $oldTarget + * @param LinkTarget $newTarget */ public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget ) { $dbw = $this->getConnectionRef( DB_MASTER ); diff --git a/includes/widget/ComplexNamespaceInputWidget.php b/includes/widget/ComplexNamespaceInputWidget.php index cdcdd24e9a..69844d9826 100644 --- a/includes/widget/ComplexNamespaceInputWidget.php +++ b/includes/widget/ComplexNamespaceInputWidget.php @@ -22,20 +22,20 @@ class ComplexNamespaceInputWidget extends \OOUI\Widget { /** * @param array $config Configuration options - * @param array $config['namespace'] Configuration for the NamespaceInputWidget - * dropdown with list of namespaces - * @param string $config['namespace']['includeAllValue'] If specified, - * add an "all namespaces" option to the dropdown, and use this as the input value for it - * @param array|null $config['invert'] Configuration for the "invert selection" - * CheckboxInputWidget. If null, the checkbox will not be generated. - * @param array|null $config['associated'] Configuration for the "include associated namespace" - * CheckboxInputWidget. If null, the checkbox will not be generated. - * @param array $config['invertLabel'] Configuration for the FieldLayout with label - * wrapping the "invert selection" checkbox - * @param string $config['invertLabel']['label'] Label text for the label - * @param array $config['associatedLabel'] Configuration for the FieldLayout with label - * wrapping the "include associated namespace" checkbox - * @param string $config['associatedLabel']['label'] Label text for the label + * - array $config['namespace'] Configuration for the NamespaceInputWidget + * dropdown with list of namespaces + * - string $config['namespace']['includeAllValue'] If specified, + * add an "all namespaces" option to the dropdown, and use this as the input value for it + * - array|null $config['invert'] Configuration for the "invert selection" + * CheckboxInputWidget. If null, the checkbox will not be generated. + * - array|null $config['associated'] Configuration for the "include associated namespace" + * CheckboxInputWidget. If null, the checkbox will not be generated. + * - array $config['invertLabel'] Configuration for the FieldLayout with label + * wrapping the "invert selection" checkbox + * - string $config['invertLabel']['label'] Label text for the label + * - array $config['associatedLabel'] Configuration for the FieldLayout with label + * wrapping the "include associated namespace" checkbox + * - string $config['associatedLabel']['label'] Label text for the label */ public function __construct( array $config = [] ) { // Configuration initialization diff --git a/includes/widget/ComplexTitleInputWidget.php b/includes/widget/ComplexTitleInputWidget.php index aec6619777..e111a972b6 100644 --- a/includes/widget/ComplexTitleInputWidget.php +++ b/includes/widget/ComplexTitleInputWidget.php @@ -19,9 +19,9 @@ class ComplexTitleInputWidget extends \OOUI\Widget { * Like TitleInputWidget, but the namespace has to be input through a separate dropdown field. * * @param array $config Configuration options - * @param array $config['namespace'] Configuration for the NamespaceInputWidget dropdown - * with list of namespaces - * @param array $config['title'] Configuration for the TitleInputWidget text field + * - array $config['namespace'] Configuration for the NamespaceInputWidget dropdown + * with list of namespaces + * - array $config['title'] Configuration for the TitleInputWidget text field */ public function __construct( array $config = [] ) { // Configuration initialization diff --git a/includes/widget/DateInputWidget.php b/includes/widget/DateInputWidget.php index 0231cacc00..afa6570562 100644 --- a/includes/widget/DateInputWidget.php +++ b/includes/widget/DateInputWidget.php @@ -28,29 +28,29 @@ class DateInputWidget extends \OOUI\TextInputWidget { /** * @param array $config Configuration options - * @param string $config['inputFormat'] Date format string to use for the textual input field. - * Displayed while the widget is active, and the user can type in a date in this format. - * Should be short and easy to type. (default: 'YYYY-MM-DD' or 'YYYY-MM', depending on - * `precision`) - * @param string $config['displayFormat'] Date format string to use for the clickable label. - * while the widget is inactive. Should be as unambiguous as possible (for example, prefer - * to spell out the month, rather than rely on the order), even if that makes it longer. - * Applicable only if the widget is infused. (default: language-specific) - * @param string $config['longDisplayFormat'] If a custom displayFormat is not specified, use - * unabbreviated day of the week and month names in the default language-specific - * displayFormat. (default: false) - * @param string $config['placeholderLabel'] Placeholder text shown when the widget is not - * selected. Applicable only if the widget is infused. (default: taken from message - * `mw-widgets-dateinput-no-date`) - * @param string $config['placeholderDateFormat'] User-visible date format string displayed - * in the textual input field when it's empty. Should be the same as `inputFormat`, but - * translated to the user's language. (default: 'YYYY-MM-DD' or 'YYYY-MM', depending on - * `precision`) - * @param string $config['precision'] Date precision to use, 'day' or 'month' (default: 'day') - * @param string $config['mustBeAfter'] Validates the date to be after this. - * In the 'YYYY-MM-DD' or 'YYYY-MM' format, depending on `precision`. - * @param string $config['mustBeBefore'] Validates the date to be before this. - * In the 'YYYY-MM-DD' or 'YYYY-MM' format, depending on `precision`. + * - string $config['inputFormat'] Date format string to use for the textual input field. + * Displayed while the widget is active, and the user can type in a date in this format. + * Should be short and easy to type. (default: 'YYYY-MM-DD' or 'YYYY-MM', depending on + * `precision`) + * - string $config['displayFormat'] Date format string to use for the clickable label. + * while the widget is inactive. Should be as unambiguous as possible (for example, prefer + * to spell out the month, rather than rely on the order), even if that makes it longer. + * Applicable only if the widget is infused. (default: language-specific) + * - string $config['longDisplayFormat'] If a custom displayFormat is not specified, use + * unabbreviated day of the week and month names in the default language-specific + * displayFormat. (default: false) + * - string $config['placeholderLabel'] Placeholder text shown when the widget is not + * selected. Applicable only if the widget is infused. (default: taken from message + * `mw-widgets-dateinput-no-date`) + * - string $config['placeholderDateFormat'] User-visible date format string displayed + * in the textual input field when it's empty. Should be the same as `inputFormat`, but + * translated to the user's language. (default: 'YYYY-MM-DD' or 'YYYY-MM', depending on + * `precision`) + * - string $config['precision'] Date precision to use, 'day' or 'month' (default: 'day') + * - string $config['mustBeAfter'] Validates the date to be after this. + * In the 'YYYY-MM-DD' or 'YYYY-MM' format, depending on `precision`. + * - string $config['mustBeBefore'] Validates the date to be before this. + * In the 'YYYY-MM-DD' or 'YYYY-MM' format, depending on `precision`. */ public function __construct( array $config = [] ) { $config = array_merge( [ diff --git a/includes/widget/DateTimeInputWidget.php b/includes/widget/DateTimeInputWidget.php index 4c412121ef..b726f3c6cc 100644 --- a/includes/widget/DateTimeInputWidget.php +++ b/includes/widget/DateTimeInputWidget.php @@ -21,10 +21,10 @@ class DateTimeInputWidget extends \OOUI\InputWidget { /** * @param array $config Configuration options - * @param string $config['type'] 'date', 'time', or 'datetime' - * @param string $config['min'] Minimum date, time, or datetime - * @param string $config['max'] Maximum date, time, or datetime - * @param bool $config['clearable'] Whether to provide for blanking the value. + * - string $config['type'] 'date', 'time', or 'datetime' + * - string $config['min'] Minimum date, time, or datetime + * - string $config['max'] Maximum date, time, or datetime + * - bool $config['clearable'] Whether to provide for blanking the value. */ public function __construct( array $config = [] ) { // We need $this->type set before calling the parent constructor diff --git a/includes/widget/NamespaceInputWidget.php b/includes/widget/NamespaceInputWidget.php index c638891ca0..6a0c0da269 100644 --- a/includes/widget/NamespaceInputWidget.php +++ b/includes/widget/NamespaceInputWidget.php @@ -16,9 +16,9 @@ class NamespaceInputWidget extends \OOUI\DropdownInputWidget { /** * @param array $config Configuration options - * @param string $config['includeAllValue'] If specified, add a "all namespaces" option to the + * - string $config['includeAllValue'] If specified, add a "all namespaces" option to the * namespace dropdown, and use this as the input value for it - * @param int[] $config['exclude'] List of namespace numbers to exclude from the selector + * - int[] $config['exclude'] List of namespace numbers to exclude from the selector */ public function __construct( array $config = [] ) { // Configuration initialization diff --git a/includes/widget/SearchInputWidget.php b/includes/widget/SearchInputWidget.php index e2428ba934..e468396204 100644 --- a/includes/widget/SearchInputWidget.php +++ b/includes/widget/SearchInputWidget.php @@ -20,13 +20,13 @@ class SearchInputWidget extends TitleInputWidget { /** * @param array $config Configuration options - * @param int|null $config['pushPending'] Whether the input should be visually marked as - * "pending", while requesting suggestions (default: false) - * @param bool|null $config['performSearchOnClick'] If true, the script will start a search - * whenever a user hits a suggestion. If false, the text of the suggestion is inserted into the - * text field only (default: true) - * @param string $config['dataLocation'] Where the search input field will be - * used (header or content, default: header) + * - int|null $config['pushPending'] Whether the input should be visually marked as + * "pending", while requesting suggestions (default: false) + * - bool|null $config['performSearchOnClick'] If true, the script will start a search + * whenever a user hits a suggestion. If false, the text of the suggestion is inserted into + * the text field only (default: true) + * - string $config['dataLocation'] Where the search input field will be + * used (header or content, default: header) */ public function __construct( array $config = [] ) { $config = array_merge( [ diff --git a/includes/widget/SelectWithInputWidget.php b/includes/widget/SelectWithInputWidget.php index 45dd1aa549..994906a33b 100644 --- a/includes/widget/SelectWithInputWidget.php +++ b/includes/widget/SelectWithInputWidget.php @@ -22,9 +22,9 @@ class SelectWithInputWidget extends \OOUI\Widget { * A version of the SelectWithInputWidget, with `or` set to true. * * @param array $config Configuration options - * @param array $config['textinput'] Configuration for the TextInputWidget - * @param array $config['dropdowninput'] Configuration for the DropdownInputWidget - * @param bool $config['or'] Configuration for whether the widget is dropdown AND input + * - array $config['textinput'] Configuration for the TextInputWidget + * - array $config['dropdowninput'] Configuration for the DropdownInputWidget + * - bool $config['or'] Configuration for whether the widget is dropdown AND input * or dropdown OR input */ public function __construct( array $config = [] ) { diff --git a/includes/widget/TitleInputWidget.php b/includes/widget/TitleInputWidget.php index 15f48e5130..aca9163174 100644 --- a/includes/widget/TitleInputWidget.php +++ b/includes/widget/TitleInputWidget.php @@ -20,14 +20,14 @@ class TitleInputWidget extends \OOUI\TextInputWidget { /** * @param array $config Configuration options - * @param int|null $config['namespace'] Namespace to prepend to queries - * @param bool|null $config['relative'] If a namespace is set, - * return a title relative to it (default: true) - * @param bool|null $config['suggestions'] Display search suggestions (default: true) - * @param bool|null $config['highlightFirst'] Automatically highlight - * the first result (default: true) - * @param bool|null $config['validateTitle'] Whether the input must - * be a valid title (default: true) + * - int|null $config['namespace'] Namespace to prepend to queries + * - bool|null $config['relative'] If a namespace is set, + * return a title relative to it (default: true) + * - bool|null $config['suggestions'] Display search suggestions (default: true) + * - bool|null $config['highlightFirst'] Automatically highlight + * the first result (default: true) + * - bool|null $config['validateTitle'] Whether the input must + * be a valid title (default: true) */ public function __construct( array $config = [] ) { parent::__construct( diff --git a/includes/widget/UsersMultiselectWidget.php b/includes/widget/UsersMultiselectWidget.php index 5c4a91fc9f..69fa1f8e9b 100644 --- a/includes/widget/UsersMultiselectWidget.php +++ b/includes/widget/UsersMultiselectWidget.php @@ -20,9 +20,9 @@ class UsersMultiselectWidget extends \OOUI\Widget { /** * @param array $config Configuration options - * @param array $config['users'] Array of usernames to use as preset data - * @param array $config['placeholder'] Placeholder message for input - * @param array $config['name'] Name attribute (used in forms) + * - array $config['users'] Array of usernames to use as preset data + * - array $config['placeholder'] Placeholder message for input + * - array $config['name'] Name attribute (used in forms) */ public function __construct( array $config = [] ) { parent::__construct( $config );