wikimedia / mediawiki

includes/parser/ParserCache.php

Doc Comments +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
 	/**
 	 * @param WikiPage $article
 	 * @param string $hash
-	 * @return mixed|string
+	 * @return string
 	 */
 	protected function getParserOutputKey( $article, $hash ) {
 		global $wgRequest;
@@ -73,7 +73,7 @@ 
 
 	/**
 	 * @param WikiPage $article
-	 * @return mixed|string
+	 * @return string
 	 */
 	protected function getOptionsKey( $article ) {
 		$pageid = $article->getId();
@@ -128,7 +128,7 @@ 
 	 * @param WikiPage $article
 	 * @param ParserOptions $popts
 	 * @param bool $useOutdated (default true)
-	 * @return bool|mixed|string
+	 * @return false|string
 	 */
 	public function getKey( $article, $popts, $useOutdated = true ) {
 		global $wgCacheEpoch;
@@ -180,7 +180,7 @@ 
 	 * Retrieve the ParserOutput from ParserCache.
 	 * false if not found or outdated.
 	 *
-	 * @param WikiPage|Article $article
+	 * @param WikiPage $article
 	 * @param ParserOptions $popts
 	 * @param bool $useOutdated (default false)
 	 *

includes/search/SearchEngine.php

Doc Comments +7 added lines, -6 removed lines

@@ -97,8 +97,8 @@ 
 	 * Way to pass custom data for engines
 	 * @since 1.18
 	 * @param string $feature
-	 * @param mixed $data
-	 * @return bool
+	 * @param boolean $data
+	 * @return boolean|null
 	 */
 	public function setFeatureData( $feature, $data ) {
 		$this->features[$feature] = $data;
@@ -295,7 +295,7 @@ 
 
 	/**
 	 * Find snippet highlight settings for all users
-	 * @return array Contextlines, contextchars
+	 * @return integer[] Contextlines, contextchars
 	 */
 	public static function userHighlightPrefs() {
 		$contextlines = 2; // Hardcode this. Old defaults sucked. :)
@@ -501,6 +501,7 @@ 
 	 * Process completion search results.
 	 * Resolves the titles and rescores.
 	 * @param SearchSuggestionSet $suggestions
+	 * @param string $search
 	 * @return SearchSuggestionSet
 	 */
 	protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
@@ -584,7 +585,7 @@ 
 	 * settings, returning a list of index numbers.
 	 * @deprecated since 1.27; use SearchEngineConfig::userNamespaces()
 	 * @param user $user
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function userNamespaces( $user ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->userNamespaces( $user );
@@ -593,7 +594,7 @@ 
 	/**
 	 * An array of namespaces indexes to be searched by default
 	 * @deprecated since 1.27; use SearchEngineConfig::defaultNamespaces()
-	 * @return array
+	 * @return integer[]
 	 */
 	public static function defaultNamespaces() {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
@@ -604,7 +605,7 @@ 
 	 * and preferences
 	 * @deprecated since 1.27; use SearchEngineConfig::namespacesAsText()
 	 * @param array $namespaces
-	 * @return array
+	 * @return string[]
 	 */
 	public static function namespacesAsText( $namespaces ) {
 		return MediaWikiServices::getInstance()->getSearchEngineConfig()->namespacesAsText( $namespaces );

includes/specials/SpecialBlock.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
 	 * If the user has already been blocked with similar settings, load that block
 	 * and change the defaults for the form fields to match the existing settings.
 	 * @param array $fields HTMLForm descriptor array
-	 * @return bool Whether fields were altered (that is, whether the target is
+	 * @return boolean|null Whether fields were altered (that is, whether the target is
 	 *     already blocked)
 	 */
 	protected function maybeAlterFormDefaults( &$fields ) {

includes/widget/SearchInputWidget.php

Doc Comments -7 removed lines

@@ -20,13 +20,6 @@
 
 	/**
 	 * @param array $config Configuration options
-	 * @param int|null $config['pushPending'] Whether the input should be visually marked as
-	 *  "pending", while requesting suggestions (default: true)
-	 * @param boolean|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)
 	 */
 	public function __construct( array $config = [] ) {
 		$config = array_merge( [

includes/api/ApiBase.php

Doc Comments +13 added lines, -9 removed lines

@@ -408,7 +408,7 @@ 
 	 * Returning true will generate errors indicating that the API module needs
 	 * updating.
 	 *
-	 * @return string|false
+	 * @return boolean
 	 */
 	public function needsToken() {
 		return false;
@@ -421,7 +421,7 @@ 
 	 *
 	 * @since 1.24
 	 * @param array $params All supplied parameters for the module
-	 * @return string|array|null
+	 * @return string
 	 */
 	protected function getWebUITokenSalt( array $params ) {
 		return null;
@@ -486,7 +486,7 @@ 
 	/**
 	 * Get the parent of this module
 	 * @since 1.25
-	 * @return ApiBase|null
+	 * @return ApiMain
 	 */
 	public function getParent() {
 		return $this->isMain() ? null : $this->getMain();
@@ -621,6 +621,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -704,6 +705,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which exactly one must be set
+	 * @param string $required
 	 */
 	public function requireOnlyOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -730,6 +732,7 @@ 
 	 *
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at most one must be set
+	 * @param string $required
 	 */
 	public function requireMaxOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -753,6 +756,7 @@ 
 	 * @since 1.23
 	 * @param array $params User provided set of parameters, as from $this->extractRequestParams()
 	 * @param string $required,... Names of parameters of which at least one must be set
+	 * @param string $required
 	 */
 	public function requireAtLeastOneParameter( $params, $required /*...*/ ) {
 		$required = func_get_args();
@@ -2531,7 +2535,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2567,7 +2571,7 @@ 
 	 * that value, and boolean false means "no examples".
 	 *
 	 * @deprecated since 1.25, use getExamplesMessages() instead
-	 * @return bool|string|array
+	 * @return boolean
 	 */
 	protected function getExamples() {
 		return false;
@@ -2576,7 +2580,7 @@ 
 	/**
 	 * Generates help message for this module, or false if there is no description
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string
 	 */
 	public function makeHelpMsg() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2686,7 +2690,7 @@ 
 	 * Generates the parameter descriptions for this module, to be displayed in the
 	 * module's help.
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function makeHelpMsgParameters() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2877,7 +2881,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2900,7 +2904,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/parser/BlockLevelPass.php

Doc Comments +2 added lines

@@ -53,6 +53,8 @@
 
 	/**
 	 * Private constructor
+	 * @param string $text
+	 * @param boolean $lineStart
 	 */
 	private function __construct( $text, $lineStart ) {
 		$this->text = $text;

maintenance/backup.inc

Doc Comments +5 added lines, -1 removed lines

@@ -334,7 +334,7 @@ 
 	 * Force the dump to use the provided database connection for database
 	 * operations, wherever possible.
 	 *
-	 * @param DatabaseBase|null $db (Optional) the database connection to use. If null, resort to
+	 * @param null|IDatabase $db (Optional) the database connection to use. If null, resort to
 	 *   use the globally provided ways to get database connections.
 	 */
 	function setDB( IDatabase $db = null ) {
@@ -422,6 +422,10 @@ 
 }
 
 class ExportProgressFilter extends DumpFilter {
+
+	/**
+	 * @param BackupDumper $progress
+	 */
 	function __construct( &$sink, &$progress ) {
 		parent::__construct( $sink );
 		$this->progress = $progress;

maintenance/backupPrefetch.inc

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 	protected $lastRev = 0;
 	protected $infiles = null;
 
+	/**
+	 * @param string $infile
+	 */
 	public function __construct( $infile ) {
 		$this->infiles = explode( ';', $infile );
 		$this->reader = new XMLReader();

maintenance/cleanupImages.php

Doc Comments +6 added lines

@@ -117,10 +117,16 @@
 		return $this->repo->getRootDirectory() . '/' . $this->repo->getHashPath( $name ) . $name;
 	}
 
+	/**
+	 * @param IDatabase $db
+	 */
 	private function imageExists( $name, $db ) {
 		return $db->selectField( 'image', '1', [ 'img_name' => $name ], __METHOD__ );
 	}
 
+	/**
+	 * @param IDatabase $db
+	 */
 	private function pageExists( $name, $db ) {
 		return $db->selectField(
 			'page',