wikimedia / mediawiki

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/db/Database.php

Doc Comments +15 added lines, -5 removed lines

@@ -674,7 +674,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	protected function restoreErrorHandler() {
 		restore_error_handler();
@@ -904,6 +904,12 @@ 
 		return $res;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param string $commentedSql
+	 * @param boolean $isWrite
+	 * @param string $fname
+	 */
 	private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
 		$isMaster = !is_null( $this->getLBInfo( 'master' ) );
 		# generalizeSQL() will probably cut down the query to reasonable
@@ -944,6 +950,10 @@ 
 		return $ret;
 	}
 
+	/**
+	 * @param string $sql
+	 * @param boolean $priorWritesPending
+	 */
 	private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
 		# Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
 		# Dropped connections also mean that named locks are automatically released.
@@ -1164,7 +1174,7 @@ 
 	 *
 	 * @param array $options Associative array of options to be turned into
 	 *   an SQL query, valid keys are listed in the function.
-	 * @return array
+	 * @return string[]
 	 * @see DatabaseBase::select()
 	 */
 	public function makeSelectOptions( $options ) {
@@ -3075,8 +3085,8 @@ 
 	 * on object's error ignore settings).
 	 *
 	 * @param string $filename File name to open
-	 * @param bool|callable $lineCallback Optional function called before reading each line
-	 * @param bool|callable $resultCallback Optional function called for each MySQL result
+	 * @param boolean $lineCallback Optional function called before reading each line
+	 * @param boolean $resultCallback Optional function called for each MySQL result
 	 * @param bool|string $fname Calling function name or false if name should be
 	 *   generated dynamically using $filename
 	 * @param bool|callable $inputCallback Optional function called for each
@@ -3423,7 +3433,7 @@ 
 	}
 
 	/**
-	 * @return string|bool Reason this DB is read-only or false if it is not
+	 * @return string|false Reason this DB is read-only or false if it is not
 	 */
 	protected function getReadOnlyReason() {
 		$reason = $this->getLBInfo( 'readOnlyReason' );

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).