wikimedia / mediawiki

includes/specials/pagers/AllMessagesTablePager.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/pagers/CategoryPager.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/pagers/DeletedContribsPager.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
 	 */
 	protected $mNavigationBar;
 
+	/**
+	 * @param string|null $target
+	 */
 	function __construct( IContextSource $context, $target, $namespace = false ) {
 		parent::__construct( $context );
 		$msgs = [ 'deletionlog', 'undeleteviewlink', 'diff' ];

includes/specials/pagers/NewPagesPager.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
 	 */
 	protected $mForm;
 
+	/**
+	 * @param SpecialNewpages $form
+	 */
 	function __construct( $form, FormOptions $opts ) {
 		parent::__construct( $form->getContext() );
 		$this->mForm = $form;

includes/specials/pagers/ProtectedTitlesPager.php

Doc Comments +6 added lines

@@ -198,6 +198,12 @@
 class ProtectedTitlesPager extends AlphabeticPager {
 	public $mForm, $mConds;
 
+	/**
+	 * @param SpecialProtectedtitles $form
+	 * @param null|string $type
+	 * @param null|string $level
+	 * @param integer|null $namespace
+	 */
 	function __construct( $form, $conds = array(), $type, $level, $namespace,
 		$sizetype = '', $size = 0
 	) {

includes/specials/SpecialDeletedContributions.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,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/SpecialNewpages.php

Doc Comments +6 added lines

@@ -39,6 +39,9 @@ 
 		parent::__construct( 'Newpages' );
 	}
 
+	/**
+	 * @param string $par
+	 */
 	protected function setup( $par ) {
 		// Options
 		$opts = new FormOptions();
@@ -457,6 +460,9 @@ 
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function feedItemAuthor( $row ) {
 		return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
 	}

includes/parser/Preprocessor.php

Doc Comments +7 added lines, -8 removed lines

@@ -56,6 +56,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
+	 * @param string $tree
 	 */
 	protected function cacheSetTree( $text, $flags, $tree ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -84,7 +85,7 @@ 
 	 *
 	 * @param string $text
 	 * @param int $flags
-	 * @return PPNode_Hash_Tree|bool
+	 * @return false|string
 	 */
 	protected function cacheGetTree( $text, $flags ) {
 		$config = RequestContext::getMain()->getConfig();
@@ -128,7 +129,7 @@ 
 	 * Create a new custom frame for programmatic use of parameter replacement
 	 * as used in some extensions.
 	 *
-	 * @param array $args
+	 * @param boolean $args
 	 *
 	 * @return PPFrame
 	 */
@@ -182,7 +183,7 @@ 
 
 	/**
 	 * Expand a document tree node, caching the result on its parent with the given key
-	 * @param string|int $key
+	 * @param string $key
 	 * @param string|PPNode $root
 	 * @param int $flags
 	 * @return string
@@ -201,7 +202,6 @@ 
 	 * Implode with flags for expand()
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ );
@@ -209,7 +209,6 @@ 
 	/**
 	 * Implode with no flags specified
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ );
@@ -218,7 +217,6 @@ 
 	 * Makes an object that, when expand()ed, will be the same as one obtained
 	 * with implode()
 	 * @param string $sep
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualImplode( $sep /*, ... */ );
@@ -228,7 +226,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode $args,...
 	 * @return PPNode
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
@@ -260,7 +257,7 @@ 
 
 	/**
 	 * Get an argument to this frame by name
-	 * @param int|string $name
+	 * @param string $name
 	 * @return string|bool
 	 */
 	public function getArgument( $name );
@@ -289,6 +286,7 @@ 
 	 * to respect it, and it may be removed in the future.
 	 *
 	 * @param bool $flag
+	 * @return void
 	 */
 	public function setVolatile( $flag = true );
 
@@ -325,6 +323,7 @@ 
 	 *
 	 * @see self::getTTL()
 	 * @param int $ttl
+	 * @return void
 	 */
 	public function setTTL( $ttl );
 

includes/parser/Preprocessor_DOM.php

Doc Comments +6 added lines, -7 removed lines

@@ -1296,7 +1296,6 @@ 
 	/**
 	 * @param string $sep
 	 * @param int $flags
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return string
 	 */
 	public function implodeWithFlags( $sep, $flags /*, ... */ ) {
@@ -1328,7 +1327,6 @@ 
 	 * This previously called implodeWithFlags but has now been inlined to reduce stack depth
 	 *
 	 * @param string $sep
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return string
 	 */
 	public function implode( $sep /*, ... */ ) {
@@ -1360,7 +1358,6 @@ 
 	 * with implode()
 	 *
 	 * @param string $sep
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualImplode( $sep /*, ... */ ) {
@@ -1392,7 +1389,6 @@ 
 	 * @param string $start
 	 * @param string $sep
 	 * @param string $end
-	 * @param string|PPNode_DOM|DOMDocument $args,...
 	 * @return array
 	 */
 	public function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1530,7 +1526,7 @@ 
 	/**
 	 * Get the TTL
 	 *
-	 * @return int|null
+	 * @return integer
 	 */
 	public function getTTL() {
 		return $this->ttl;
@@ -1555,7 +1551,7 @@ 
 
 	/**
 	 * @param Preprocessor $preprocessor
-	 * @param bool|PPFrame_DOM $parent
+	 * @param PPFrame_DOM $parent
 	 * @param array $numberedArgs
 	 * @param array $namedArgs
 	 * @param bool|Title $title
@@ -1726,6 +1722,9 @@ 
 
 	public $args;
 
+	/**
+	 * @param Preprocessor_DOM $preprocessor
+	 */
 	public function __construct( $preprocessor, $args ) {
 		parent::__construct( $preprocessor );
 		$this->args = $args;
@@ -1833,7 +1832,7 @@ 
 	/**
 	 * @param string $type
 	 *
-	 * @return bool|PPNode_DOM
+	 * @return PPNode_DOM
 	 */
 	public function getChildrenOfType( $type ) {
 		return new self( $this->getXPath()->query( $type, $this->node ) );