Merge "Add missing @param and @return documentation"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Fri, 11 Aug 2017 21:32:58 +0000 (21:32 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 11 Aug 2017 21:32:58 +0000 (21:32 +0000)
1  2 
includes/search/SearchEngine.php
includes/specialpage/LoginSignupSpecialPage.php
includes/specials/SpecialMediaStatistics.php

@@@ -138,7 -138,7 +138,7 @@@ abstract class SearchEngine 
         * @return mixed the feature value or null if unset
         */
        public function getFeatureData( $feature ) {
 -              if ( isset ( $this->features[$feature] ) ) {
 +              if ( isset( $this->features[$feature] ) ) {
                        return $this->features[$feature];
                }
                return null;
        /**
         * Process completion search results.
         * Resolves the titles and rescores.
+        * @param string $search
         * @param SearchSuggestionSet $suggestions
         * @return SearchSuggestionSet
         */
@@@ -1156,7 -1156,7 +1156,7 @@@ abstract class LoginSignupSpecialPage e
                        // Don't show a "create account" link if the user can't.
                        if ( $this->showCreateAccountLink() ) {
                                // link to the other action
 -                              $linkTitle = $this->getTitleFor( $this->isSignup() ? 'Userlogin' :'CreateAccount' );
 +                              $linkTitle = $this->getTitleFor( $this->isSignup() ? 'Userlogin' : 'CreateAccount' );
                                $linkq = $this->getReturnToQueryStringFragment();
                                // Pass any language selection on to the mode switch link
                                if ( $this->mLanguage ) {
        /**
         * Returns a string that can be appended to the URL (without encoding) to preserve the
         * return target. Does not include leading '?'/'&'.
+        * @return string
         */
        protected function getReturnToQueryStringFragment() {
                $returnto = '';
  
        /**
         * @param array &$formDescriptor
+        * @param array $requests
         */
        protected function postProcessFormDescriptor( &$formDescriptor, $requests ) {
                // Pre-fill username (if not creating an account, T46775).
@@@ -1395,6 -1397,11 +1397,11 @@@ class FakeAuthTemplate extends BaseTemp
        /**
         * Extensions (AntiSpoof and TitleBlacklist) call this in response to
         * UserCreateForm hook to add checkboxes to the create account form.
+        * @param string $name
+        * @param string $value
+        * @param string $type
+        * @param string $msg
+        * @param string|bool $helptext
         */
        public function addInputItem( $name, $value, $type, $msg, $helptext = false ) {
                // use the same indexes as UserCreateForm just in case someone adds an item manually
@@@ -1496,6 -1503,7 +1503,7 @@@ class LoginForm extends SpecialPage 
  
        /**
         * @deprecated since 1.27 - call LoginHelper::getValidErrorMessages instead.
+        * @return array
         */
        public static function getValidErrorMessages() {
                return LoginHelper::getValidErrorMessages();
  
        /**
         * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+        * @param string $username
+        * @return array|false
         */
        public static function incrementLoginThrottle( $username ) {
                wfDeprecated( __METHOD__, "1.27" );
  
        /**
         * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+        * @param string $username
+        * @return bool|int
         */
        public static function incLoginThrottle( $username ) {
                wfDeprecated( __METHOD__, "1.27" );
  
        /**
         * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+        * @param string $username
+        * @return void
         */
        public static function clearLoginThrottle( $username ) {
                wfDeprecated( __METHOD__, "1.27" );
  
        /**
         * @deprecated since 1.27 - don't use LoginForm, use AuthManager instead
+        * @return string
         */
        public static function getCreateaccountToken() {
                wfDeprecated( __METHOD__, '1.27' );
@@@ -63,6 -63,7 +63,7 @@@ class MediaStatisticsPage extends Query
         * come out of querycache table is the order they went in. Which is hacky.
         * However, other special pages like Special:Deadendpages and
         * Special:BrokenRedirects also rely on this.
+        * @return array
         */
        public function getQueryInfo() {
                $dbr = wfGetDB( DB_REPLICA );
                $row .= Html::rawElement(
                        'td',
                        // Make sure js sorts it in numeric order
 -                      [ 'data-sort-value' =>  $bytes ],
 +                      [ 'data-sort-value' => $bytes ],
                        $this->msg( 'mediastatistics-nbytes' )
                                ->numParams( $bytes )
                                ->sizeParams( $bytes )
         * Output the start of the table
         *
         * Including opening <table>, and first <tr> with column headers.
+        * @param string $mediaType
         */
        protected function outputTableStart( $mediaType ) {
                $this->getOutput()->addHTML(