wikimedia / mediawiki

includes/specialpage/SpecialPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 	 * @param string $name Name of the special page, as seen in links and URLs
 	 * @param string $restriction User right required, e.g. "block" or "delete"
 	 * @param bool $listed Whether the page is listed in Special:Specialpages
-	 * @param callable|bool $function Unused
+	 * @param boolean $function Unused
 	 * @param string $file Unused
 	 * @param bool $includable Whether the page can be included in normal pages
 	 */

includes/specials/SpecialAllMessages.php

Doc Comments +11 added lines, -1 removed lines

@@ -97,6 +97,10 @@ 
 	 */
 	public $custom;
 
+	/**
+	 * @param SpecialAllMessages $page
+	 * @param Language $langObj
+	 */
 	function __construct( $page, $conds, $langObj = null ) {
 		parent::__construct( $page->getContext() );
 		$this->mIndexField = 'am_title';
@@ -223,6 +227,9 @@ 
 		return $out;
 	}
 
+	/**
+	 * @param boolean $descending
+	 */
 	function getAllMessages( $descending ) {
 		$messageNames = Language::getLocalisationCache()->getSubitemList( 'en', 'messages' );
 
@@ -247,7 +254,7 @@ 
 	 * @param array $messageNames
 	 * @param string $langcode What language code
 	 * @param bool $foreign Whether the $langcode is not the content language
-	 * @return array A 'pages' and 'talks' array with the keys of existing pages
+	 * @return string A 'pages' and 'talks' array with the keys of existing pages
 	 */
 	public static function getCustomisedStatuses( $messageNames, $langcode = 'en', $foreign = false ) {
 		// FIXME: This function should be moved to Language:: or something.
@@ -439,6 +446,9 @@ 
 		return $arr;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	function getCellAttrs( $field, $value ) {
 		if ( $this->mCurrentRow->am_customised && $field === 'am_title' ) {
 			return array( 'rowspan' => '2', 'class' => $field );

includes/specials/SpecialBlock.php

Doc Comments +2 added lines, -2 removed lines

@@ -230,7 +230,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 ) {
@@ -453,7 +453,7 @@ 
 	/**
 	 * Get a user page target for things like logs.
 	 * This handles account and IP range targets.
-	 * @param User|string $target
+	 * @param User $target
 	 * @return Title|null
 	 */
 	protected static function getTargetUserTitle( $target ) {

includes/specials/SpecialBrokenRedirects.php

Doc Comments +1 added lines, -1 removed lines

@@ -85,7 +85,7 @@
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function getOrderFields() {
 		return array( 'rd_namespace', 'rd_title', 'rd_from' );

includes/specials/SpecialCategories.php

Doc Comments +3 added lines

@@ -179,6 +179,9 @@
 		return Html::rawElement( 'li', null, $this->getLanguage()->specialList( $link, $count ) ) . "\n";
 	}
 
+	/**
+	 * @param string $from
+	 */
 	public function getStartForm( $from ) {
 		return Xml::tags(
 			'form',

includes/specials/SpecialComparePages.php

Doc Comments +3 added lines

@@ -128,6 +128,9 @@
 		}
 	}
 
+	/**
+	 * @return integer
+	 */
 	public static function revOrTitle( $revision, $title ) {
 		if ( $revision ) {
 			return $revision;

includes/specials/SpecialContributions.php

Doc Comments +2 added lines, -2 removed lines

@@ -238,7 +238,7 @@ 
 	/**
 	 * Generates the subheading with links
 	 * @param User $userObj User object for the target
-	 * @return string Appropriately-escaped HTML to be output literally
+	 * @return Message Appropriately-escaped HTML to be output literally
 	 * @todo FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php.
 	 * Could be combined.
 	 */
@@ -308,7 +308,7 @@ 
 	 * @param Title $userpage Target user page
 	 * @param Title $talkpage Talk page
 	 * @param User $target Target user object
-	 * @return array
+	 * @return string[]
 	 */
 	public function getUserLinks( Title $userpage, Title $talkpage, User $target ) {
 

includes/specials/SpecialDeletedContributions.php

Doc Comments +4 added lines, -1 removed lines

@@ -37,6 +37,9 @@ 
 	 */
 	protected $mNavigationBar;
 
+	/**
+	 * @param string|null $target
+	 */
 	function __construct( IContextSource $context, $target, $namespace = false ) {
 		parent::__construct( $context );
 		$msgs = array( 'deletionlog', 'undeleteviewlink', 'diff' );
@@ -459,7 +462,7 @@ 
 	/**
 	 * Generates the subheading with links
 	 * @param User $userObj User object for the target
-	 * @return string Appropriately-escaped HTML to be output literally
+	 * @return Message Appropriately-escaped HTML to be output literally
 	 * @todo FIXME: Almost the same as contributionsSub in SpecialContributions.php. Could be combined.
 	 */
 	function getSubTitle( $userObj ) {

includes/specials/SpecialEditTags.php

Doc Comments +1 added lines, -1 removed lines

@@ -348,7 +348,7 @@
 	 * ChangeTags::listExplicitlyDefinedTags, will be appended to the <select>
 	 * element.
 	 * @param string $label The text of a <label> to precede the <select>
-	 * @return array HTML <label> element at index 0, HTML <select> element at
+	 * @return string[] HTML <label> element at index 0, HTML <select> element at
 	 * index 1
 	 */
 	protected function getTagSelect( $selectedTags, $label ) {