wikimedia / mediawiki

includes/page/WikiPage.php

Doc Comments +5 added lines, -5 removed lines

@@ -257,7 +257,7 @@ 
 	 * Return the list of revision fields that should be selected to create
 	 * a new page.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
@@ -1144,7 +1144,7 @@ 
 	 * @param IDatabase $dbw
 	 * @param int|null $pageId Custom page ID that will be used for the insert statement
 	 *
-	 * @return bool|int The newly created page_id key; false if the row was not
+	 * @return integer The newly created page_id key; false if the row was not
 	 *   inserted, e.g. because the title already existed or because the specified
 	 *   page ID is already in use.
 	 */
@@ -1491,7 +1491,7 @@ 
 	 * error will be returned. These two conditions are also possible with
 	 * auto-detection due to MediaWiki's performance-optimised locking strategy.
 	 *
-	 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
+	 * @param boolean $baseRevId The revision ID this edit was based off, if any.
 	 *   This is not the parent revision ID, rather the revision ID for older
 	 *   content used as the source for a rollback, for example.
 	 * @param User $user The user doing the edit
@@ -3370,7 +3370,7 @@ 
 	 * Returns a list of categories this page is a member of.
 	 * Results will include hidden categories
 	 *
-	 * @return TitleArray
+	 * @return TitleArrayFromResult|null
 	 */
 	public function getCategories() {
 		$id = $this->getId();
@@ -3445,7 +3445,7 @@ 
 	 * Auto-generates a deletion reason
 	 *
 	 * @param bool &$hasHistory Whether the page has a history
-	 * @return string|bool String containing deletion reason or empty string, or boolean false
+	 * @return false|string String containing deletion reason or empty string, or boolean false
 	 *    if no revision occurred
 	 */
 	public function getAutoDeleteReason( &$hasHistory ) {

maintenance/hhvm/makeRepo.php

Doc Comments +3 added lines

@@ -129,6 +129,9 @@
 		return 0;
 	}
 
+	/**
+	 * @param string $tmpDir
+	 */
 	private function cleanupTemp( $tmpDir ) {
 		if ( file_exists( "$tmpDir/hhvm.hhbc" ) ) {
 			unlink( "$tmpDir/hhvm.hhbc" );

includes/GlobalFunctions.php

Doc Comments +14 added lines, -20 removed lines

@@ -234,7 +234,6 @@ 
  *   		[ 'y' ]
  *   	]
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -261,8 +260,8 @@ 
  *
  * @param array $array The array.
  * @param array $insert The array to insert.
- * @param mixed $after The key to insert after
- * @return array
+ * @param string $after The key to insert after
+ * @return string[]
  */
 function wfArrayInsertAfter( array $array, array $insert, $after ) {
 	// Find the offset of the element to insert after.
@@ -1300,7 +1299,7 @@ 
 /**
  * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
  *
- * @return string|bool String when in read-only mode; false otherwise
+ * @return string|false String when in read-only mode; false otherwise
  * @since 1.27
  */
 function wfConfiguredReadOnlyReason() {
@@ -1375,7 +1374,6 @@ 
  * This function replaces all old wfMsg* functions.
  *
  * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
- * @param mixed $params,... Normal message parameters
  * @return Message
  *
  * @since 1.17
@@ -1396,7 +1394,6 @@ 
  * for the first message which is non-empty. If all messages are empty then an
  * instance of the first message key is returned.
  *
- * @param string|string[] $keys,... Message keys
  * @return Message
  *
  * @since 1.18
@@ -1627,7 +1624,7 @@ 
  * @todo FIXME: We may want to blacklist some broken browsers
  *
  * @param bool $force
- * @return bool Whereas client accept gzip compression
+ * @return null|boolean Whereas client accept gzip compression
  */
 function wfClientAcceptsGzip( $force = false ) {
 	static $result = null;
@@ -1713,7 +1710,7 @@ 
  * @param mixed $dest
  * @param mixed $source
  * @param bool $force
- * @return mixed
+ * @return string
  */
 function wfSetVar( &$dest, $source, $force = false ) {
 	$temp = $dest;
@@ -1763,7 +1760,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2045,8 +2042,8 @@ 
  *
  * @param mixed $outputtype A timestamp in one of the supported formats, the
  *   function will autodetect which format is supplied and act accordingly.
- * @param mixed $ts Optional timestamp to convert, default 0 for the current time
- * @return string|bool String / false The same date in the format specified in $outputtype or false
+ * @param integer $ts Optional timestamp to convert, default 0 for the current time
+ * @return string|false String / false The same date in the format specified in $outputtype or false
  */
 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
 	try {
@@ -2087,7 +2084,7 @@ 
 /**
  * Check if the operating system is Windows
  *
- * @return bool True if it's Windows, false otherwise.
+ * @return boolean|null True if it's Windows, false otherwise.
  */
 function wfIsWindows() {
 	static $isWindows = null;
@@ -2344,7 +2341,7 @@ 
 /**
  * Check if wfShellExec() is effectively disabled via php.ini config
  *
- * @return bool|string False or 'disabled'
+ * @return string|false False or 'disabled'
  * @since 1.22
  */
 function wfShellExecDisabled() {
@@ -2958,7 +2955,7 @@ 
  * @param int $pad Minimum number of digits in the output (pad with zeroes)
  * @param bool $lowercase Whether to output in lowercase or uppercase
  * @param string $engine Either "gmp", "bcmath", or "php"
- * @return string|bool The output number as a string, or false on error
+ * @return false|string The output number as a string, or false on error
  */
 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
 	$lowercase = true, $engine = 'auto'
@@ -3043,7 +3040,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3060,7 +3056,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3080,7 +3075,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3195,7 +3189,7 @@ 
  * Returns a valid placeholder object if the file does not exist.
  *
  * @param Title|string $title
- * @return LocalFile|null A File, or null if passed an invalid Title
+ * @return File|null A File, or null if passed an invalid Title
  */
 function wfLocalFile( $title ) {
 	return RepoGroup::singleton()->getLocalRepo()->newFile( $title );
@@ -3400,7 +3394,7 @@ 
 /**
  * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
  *
- * @return int Prior time limit
+ * @return string Prior time limit
  * @since 1.26
  */
 function wfTransactionalTimeLimit() {
@@ -3536,7 +3530,7 @@ 
  *
  * @param string $format The format string (See php's docs)
  * @param string $data A binary string of binary data
- * @param int|bool $length The minimum length of $data or false. This is to
+ * @param integer $length The minimum length of $data or false. This is to
  *	prevent reading beyond the end of $data. false to disable the check.
  *
  * Also be careful when using this function to read unsigned 32 bit integer

includes/specialpage/LoginSignupSpecialPage.php

Doc Comments +5 added lines, -2 removed lines

@@ -81,6 +81,9 @@ 
 	 */
 	abstract protected function logAuthResult( $success, $status = null );
 
+	/**
+	 * @param string $name
+	 */
 	public function __construct( $name ) {
 		global $wgUseMediaWikiUIEverywhere;
 		parent::__construct( $name );
@@ -365,7 +368,7 @@ 
 	 * Show the success page.
 	 *
 	 * @param string $type Condition of return to; see `executeReturnTo`
-	 * @param string|Message $title Page's title
+	 * @param Message $title Page's title
 	 * @param string $msgname
 	 * @param string $injected_html
 	 * @param StatusValue|null $extraMessages
@@ -414,7 +417,6 @@ 
 	/**
 	 * Replace some globals to make sure the fact that the user has just been logged in is
 	 * reflected in the current request.
-	 * @param User $user
 	 */
 	protected function setSessionUserForCurrentRequest() {
 		global $wgUser, $wgLang;
@@ -1254,6 +1256,7 @@ 
 
 	/**
 	 * @param array $formDescriptor
+	 * @param AuthenticationRequest[] $requests
 	 */
 	protected function postProcessFormDescriptor( &$formDescriptor, $requests ) {
 		// Pre-fill username (if not creating an account, T46775).

includes/content/TextContent.php

Doc Comments +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
 	 * changes.
 	 *
 	 * @since 1.28
-	 * @param $text
+	 * @param false|string $text
 	 * @return string
 	 */
 	public static function normalizeLineEndings( $text ) {

includes/db/loadbalancer/LoadBalancer.php

Doc Comments +4 added lines, -4 removed lines

@@ -238,7 +238,7 @@ 
 	 * @param string|bool $group Query group, or false for the generic reader
 	 * @param string|bool $wiki Wiki ID, or false for the current wiki
 	 * @throws MWException
-	 * @return bool|int|string
+	 * @return string
 	 */
 	public function getReaderIndex( $group = false, $wiki = false ) {
 		global $wgDBtype;
@@ -443,7 +443,7 @@ 
 	 * Returns false if there is no connection open
 	 *
 	 * @param int $i
-	 * @return DatabaseBase|bool False on failure
+	 * @return DatabaseBase|null False on failure
 	 */
 	public function getAnyOpenConnection( $i ) {
 		foreach ( $this->mConns as $conns ) {
@@ -982,7 +982,7 @@ 
 
 	/**
 	 * Get the current master position for chronology control purposes
-	 * @return mixed
+	 * @return DBMasterPos
 	 */
 	public function getMasterPos() {
 		# If this entire request was served from a slave without opening a connection to the
@@ -1487,7 +1487,7 @@ 
 	 * case on many installations.
 	 *
 	 * @param IDatabase $conn
-	 * @return int|bool Returns false on error
+	 * @return integer Returns false on error
 	 */
 	public function safeGetLag( IDatabase $conn ) {
 		if ( $this->getServerCount() == 1 ) {

includes/upload/UploadBase.php

Doc Comments +1 added lines, -2 removed lines

@@ -295,7 +295,7 @@ 
 
 	/**
 	 * @param string $srcPath The source path
-	 * @return string|bool The real path if it was a virtual URL Returns false on failure
+	 * @return string|false The real path if it was a virtual URL Returns false on failure
 	 */
 	function getRealPath( $srcPath ) {
 		$repo = RepoGroup::singleton()->getLocalRepo();
@@ -1605,7 +1605,6 @@ 
 	 * Check a block of CSS or CSS fragment for anything that looks like
 	 * it is bringing in remote code.
 	 * @param string $value a string of CSS
-	 * @param bool $propOnly only check css properties (start regex with :)
 	 * @return bool true if the CSS contains an illegal string, false if otherwise
 	 */
 	private static function checkCssFragment( $value ) {

includes/api/ApiBase.php

Doc Comments +10 added lines, -6 removed lines

@@ -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;
@@ -627,6 +627,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -710,6 +711,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();
@@ -736,6 +738,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();
@@ -759,6 +762,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();
@@ -1431,7 +1435,7 @@ 
 
 	/**
 	 * Truncate an array to a certain length.
-	 * @param array $arr Array to truncate
+	 * @param string[] $arr Array to truncate
 	 * @param int $limit Maximum length
 	 * @return bool True if the array was truncated, false otherwise
 	 */
@@ -2638,7 +2642,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2793,7 +2797,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' );
@@ -2984,7 +2988,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -3007,7 +3011,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/profiler/Profiler.php

Doc Comments +7 added lines

@@ -145,9 +145,16 @@
 	}
 
 	// Kept BC for now, remove when possible
+
+	/**
+	 * @param string $functionname
+	 */
 	public function profileIn( $functionname ) {
 	}
 
+	/**
+	 * @param string $functionname
+	 */
 	public function profileOut( $functionname ) {
 	}