wikimedia / mediawiki

includes/libs/jsminplus.php

Doc Comments +38 added lines

@@ -207,6 +207,9 @@ 
 		return $instance->min($js, $filename);
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	private function min($js, $filename)
 	{
 		try
@@ -222,6 +225,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param JSNode $n
+	 */
 	public function parseTree($n, $noBlockGrouping = false)
 	{
 		$s = '';
@@ -660,6 +666,9 @@ 
 		return $s;
 	}
 
+	/**
+	 * @param string $string
+	 */
 	private function isValidIdentifier($string)
 	{
 		return preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $string) && !in_array($string, $this->reserved);
@@ -724,12 +733,18 @@ 
 		TOKEN_CONDCOMMENT_START => 1, TOKEN_CONDCOMMENT_END => 1
 	);
 
+	/**
+	 * @param JSMinPlus $minifier
+	 */
 	public function __construct($minifier=null)
 	{
 		$this->minifier = $minifier;
 		$this->t = new JSTokenizer();
 	}
 
+	/**
+	 * @param integer $l
+	 */
 	public function parse($s, $f, $l)
 	{
 		// initialize tokenizer
@@ -743,6 +758,9 @@ 
 		return $n;
 	}
 
+	/**
+	 * @param JSCompilerContext $x
+	 */
 	private function Script($x)
 	{
 		$n = $this->Statements($x);
@@ -1106,6 +1124,10 @@ 
 		return $n;
 	}
 
+	/**
+	 * @param boolean $requireName
+	 * @param integer $functionForm
+	 */
 	private function FunctionDefinition($x, $requireName, $functionForm)
 	{
 		$f = new JSNode($this->t);
@@ -1572,6 +1594,10 @@ 
 	}
 
 	// Statement stack and nested statement handler.
+
+	/**
+	 * @param JSNode $node
+	 */
 	private function nest($x, $node, $end = false)
 	{
 		array_push($x->stmtStack, $node);
@@ -1636,6 +1662,9 @@ 
 	public $funDecls = array();
 	public $varDecls = array();
 
+	/**
+	 * @param boolean $inFunction
+	 */
 	public function __construct($inFunction)
 	{
 		$this->inFunction = $inFunction;
@@ -1654,6 +1683,9 @@ 
 	public $funDecls = array();
 	public $varDecls = array();
 
+	/**
+	 * @param JSTokenizer $t
+	 */
 	public function __construct($t, $type=0)
 	{
 		if ($token = $t->currentToken())
@@ -1765,6 +1797,9 @@ 
 		$this->scanOperand = true;
 	}
 
+	/**
+	 * @param integer|null $chunksize
+	 */
 	public function getInput($chunksize)
 	{
 		if ($chunksize)
@@ -2112,6 +2147,9 @@ 
 		$this->tokenIndex = ($this->tokenIndex - 1) & 3;
 	}
 
+	/**
+	 * @param string $m
+	 */
 	public function newSyntaxError($m)
 	{
 		return new Exception('Parse error: ' . $m . ' in file \'' . $this->filename . '\' on line ' . $this->lineno);

includes/libs/MemoizedCallable.php

Doc Comments +1 added lines

@@ -74,6 +74,7 @@
 	 *
 	 * @param string $key
 	 * @param bool &$success
+	 * @param boolean $success
 	 */
 	protected function fetchResult( $key, &$success ) {
 		$success = false;

includes/libs/objectcache/MemcachedClient.php

Doc Comments +7 added lines, -7 removed lines

@@ -309,7 +309,7 @@ 
 	 * @param string $key Key to decrease
 	 * @param int $amt (optional) amount to decrease
 	 *
-	 * @return mixed False on failure, value on success
+	 * @return null|string False on failure, value on success
 	 */
 	public function decr( $key, $amt = 1 ) {
 		return $this->_incrdecr( 'decr', $key, $amt );
@@ -548,7 +548,7 @@ 
 	 * @param string $key Key to increment
 	 * @param int $amt (optional) amount to increment
 	 *
-	 * @return int|null Null if the key does not exist yet (this does NOT
+	 * @return null|string Null if the key does not exist yet (this does NOT
 	 * create new mappings if the key does not exist). If the key does
 	 * exist, this returns the new value for that key.
 	 */
@@ -872,10 +872,10 @@ 
 	 * Perform increment/decriment on $key
 	 *
 	 * @param string $cmd Command to perform
-	 * @param string|array $key Key to perform it on
+	 * @param string $key Key to perform it on
 	 * @param int $amt Amount to adjust
 	 *
-	 * @return int New value of $key
+	 * @return null|string New value of $key
 	 * @access private
 	 */
 	function _incrdecr( $cmd, $key, $amt = 1 ) {
@@ -915,7 +915,7 @@ 
 	 * @param Resource $sock Socket to read from
 	 * @param array $ret returned values
 	 * @param float $casToken [optional]
-	 * @return bool True for success, false for failure
+	 * @return boolean|null True for success, false for failure
 	 *
 	 * @access private
 	 */
@@ -1183,7 +1183,7 @@ 
 	 *
 	 * @param Resource $sock The socket
 	 * @param int $len The number of bytes to read
-	 * @return string|bool The string on success, false on failure.
+	 * @return false|string The string on success, false on failure.
 	 */
 	function _fread( $sock, $len ) {
 		$buf = '';
@@ -1214,7 +1214,7 @@ 
 	 * The \r\n line ending is stripped from the response.
 	 *
 	 * @param Resource $sock The socket
-	 * @return string|bool The string on success, false on failure
+	 * @return false|string The string on success, false on failure
 	 */
 	function _fgets( $sock ) {
 		$result = fgets( $sock );

includes/libs/ReplacementArray.php

Doc Comments +2 added lines, -2 removed lines

@@ -36,7 +36,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	public function __sleep() {
 		return array( 'data' );
@@ -56,7 +56,7 @@ 
 	}
 
 	/**
-	 * @return array|bool
+	 * @return boolean
 	 */
 	public function getArray() {
 		return $this->data;

includes/libs/replacers/DoubleReplacer.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,8 +23,8 @@
  */
 class DoubleReplacer extends Replacer {
 	/**
-	 * @param mixed $from
-	 * @param mixed $to
+	 * @param string $from
+	 * @param string $to
 	 * @param int $index
 	 */
 	public function __construct( $from, $to, $index = 0 ) {

includes/libs/SamplingStatsdClient.php

Doc Comments +1 added lines

@@ -35,6 +35,7 @@
 	 * The sample rate specified in a StatsdData entity overrides the sample rate specified here.
 	 *
 	 * {@inheritDoc}
+	 * @return StatsdDataInterface[]
 	 */
 	public function appendSampleRate( $data, $sampleRate = 1 ) {
 		if ( $sampleRate < 1 ) {

includes/libs/XmlTypeCheck.php

Doc Comments +6 added lines, -2 removed lines

@@ -134,7 +134,8 @@ 
 
 
 	/**
-	 * @param string $fname the filename
+	 * @param string $xml
+	 * @param boolean $isFile
 	 */
 	private function validateFromInput( $xml, $isFile ) {
 		$reader = new XMLReader();
@@ -175,6 +176,9 @@ 
 		$this->wellFormed = false;
 	}
 
+	/**
+	 * @param XMLReader $reader
+	 */
 	private function validate( $reader ) {
 
 		// First, move through anything that isn't an element, and
@@ -286,7 +290,7 @@ 
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @param $attribs
 	 */
 	private function elementOpen( $name, $attribs ) {

includes/Licenses.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
 	/**
 	 * @param array $list
 	 * @param array $path
-	 * @param mixed $item
+	 * @param License $item
 	 */
 	protected function stackItem( &$list, $path, $item ) {
 		$position =& $list;

includes/Linker.php

Doc Comments +7 added lines, -7 removed lines

@@ -706,7 +706,7 @@ 
 	/**
 	 * Make HTML for a thumbnail including image, border and caption
 	 * @param Title $title
-	 * @param File|bool $file File object or false if it doesn't exist
+	 * @param File $file File object or false if it doesn't exist
 	 * @param string $label
 	 * @param string $alt
 	 * @param string $align
@@ -1268,7 +1268,7 @@ 
 	 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
 	 *  For use with external changes.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public static function formatComment(
 		$comment, $title = null, $local = false, $wikiId = null
@@ -1494,7 +1494,7 @@ 
 	 * @param string $text
 	 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
 	 *  as used by WikiMap.
-	 * @param string|string[] $options See the $options parameter in Linker::link.
+	 * @param string $options See the $options parameter in Linker::link.
 	 *
 	 * @return string HTML link
 	 */
@@ -1736,7 +1736,7 @@ 
 	 * Generate a table of contents from a section tree.
 	 *
 	 * @param array $tree Return value of ParserOutput::getSections()
-	 * @param string|Language|bool $lang Language for the toc title, defaults to user language
+	 * @param Language $lang Language for the toc title, defaults to user language
 	 * @return string HTML fragment
 	 */
 	public static function generateTOC( $tree, $lang = false ) {
@@ -1793,7 +1793,7 @@ 
 	 * Split a link trail, return the "inside" portion and the remainder of the trail
 	 * as a two-element array
 	 * @param string $trail
-	 * @return array
+	 * @return string[]
 	 */
 	static function splitTrail( $trail ) {
 		global $wgContLang;
@@ -1831,7 +1831,7 @@ 
 	 *
 	 * @param Revision $rev
 	 * @param IContextSource $context Context to use or null for the main context.
-	 * @param array $options
+	 * @param string[] $options
 	 * @return string
 	 */
 	public static function generateRollback( $rev, IContextSource $context = null,
@@ -2013,7 +2013,7 @@ 
 	 * @param array $templates Array of templates from Article::getUsedTemplate or similar
 	 * @param bool $preview Whether this is for a preview
 	 * @param bool $section Whether this is for a section edit
-	 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
+	 * @param string|null $more An escaped link for "More..." of the templates
 	 * @return string HTML output
 	 */
 	public static function formatTemplates( $templates, $preview = false,