wikimedia / mediawiki

includes/GlobalFunctions.php

Doc Comments +13 added lines, -18 removed lines

@@ -43,6 +43,7 @@ 
 	/**
 	 * @codeCoverageIgnore
 	 * @see Fallback::mb_substr
+	 * @param integer $start
 	 * @return string
 	 */
 	function mb_substr( $str, $start, $count = 'end' ) {
@@ -85,7 +86,7 @@ 
 	/**
 	 * @codeCoverageIgnore
 	 * @see Fallback::mb_strrpos
-	 * @return int
+	 * @return string|false
 	 */
 	function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
 		return Fallback::mb_strrpos( $haystack, $needle, $offset, $encoding );
@@ -301,7 +302,6 @@ 
  *   		array( 'y' )
  *   	)
  *
- * @param array $array1,...
  * @return array
  */
 function wfMergeErrorArrays( /*...*/ ) {
@@ -1353,7 +1353,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() {
@@ -1428,7 +1428,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
@@ -1449,7 +1448,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
@@ -1680,7 +1678,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;
@@ -1816,7 +1814,7 @@ 
 /**
  * Provide a simple HTTP error.
  *
- * @param int|string $code
+ * @param integer $code
  * @param string $label
  * @param string $desc
  */
@@ -2098,8 +2096,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 {
@@ -2140,7 +2138,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;
@@ -2376,7 +2374,7 @@ 
 /**
  * Check if wfShellExec() is effectively disabled via php.ini config
  *
- * @return bool|string False or one of (safemode,disabled)
+ * @return string|false False or one of (safemode,disabled)
  * @since 1.22
  */
 function wfShellExecDisabled() {
@@ -2997,7 +2995,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'
@@ -3105,7 +3103,6 @@ 
 /**
  * Make a cache key for the local wiki.
  *
- * @param string $args,...
  * @return string
  */
 function wfMemcKey( /*...*/ ) {
@@ -3122,7 +3119,6 @@ 
  *
  * @param string $db
  * @param string $prefix
- * @param string $args,...
  * @return string
  */
 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
@@ -3142,7 +3138,6 @@ 
  * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
  *
  * @since 1.26
- * @param string $args,...
  * @return string
  */
 function wfGlobalCacheKey( /*...*/ ) {
@@ -3244,7 +3239,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 );
@@ -3468,7 +3463,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() {
@@ -3604,7 +3599,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/HistoryBlob.php

Doc Comments +5 added lines, -4 removed lines

@@ -55,6 +55,7 @@ 
 	 * Default text is not required for two-part external storage URLs.
 	 *
 	 * @param string $text
+	 * @return void
 	 */
 	function setText( $text );
 
@@ -161,7 +162,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function __sleep() {
 		$this->compress();
@@ -531,7 +532,7 @@ 
 	/**
 	 * @param string $base
 	 * @param string $diff
-	 * @return bool|string
+	 * @return string|false
 	 */
 	function patch( $base, $diff ) {
 		if ( function_exists( 'xdiff_string_bpatch' ) ) {
@@ -593,7 +594,7 @@ 
 	 * the bytes backwards and initialised with 0 instead of 1. See bug 34428.
 	 *
 	 * @param string $s
-	 * @return string|bool False if the hash extension is not available
+	 * @return false|string False if the hash extension is not available
 	 */
 	function xdiffAdler32( $s ) {
 		if ( !function_exists( 'hash' ) ) {
@@ -626,7 +627,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return string[]
 	 */
 	function __sleep() {
 		$this->compress();

includes/htmlform/HTMLButtonField.php

Doc Comments +1 added lines, -1 removed lines

@@ -125,7 +125,7 @@
 
 	/**
 	 * IE<8 has bugs with <button>, so we'll need to avoid them.
-	 * @return bool Whether the request is from a bad version of IE
+	 * @return integer Whether the request is from a bad version of IE
 	 */
 	private function isBadIE() {
 		$request = $this->mParent

includes/htmlform/HTMLCheckMatrix.php

Doc Comments +4 added lines, -1 removed lines

@@ -75,7 +75,7 @@ 
 	 * mParams['rows'] is an array with row labels as keys and row tags as values.
 	 * mParams['columns'] is an array with column labels as keys and column tags as values.
 	 *
-	 * @param array $value Array of the options that should be checked
+	 * @param string $value Array of the options that should be checked
 	 *
 	 * @return string
 	 */
@@ -151,6 +151,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			return new OOUI\CheckboxInputWidget( array(

includes/htmlform/HTMLForm.php

Doc Comments +1 added lines, -2 removed lines

@@ -250,7 +250,6 @@ 
 	 * Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
 	 *
 	 * @param string $displayFormat
-	 * @param mixed $arguments... Additional arguments to pass to the constructor.
 	 * @return HTMLForm
 	 */
 	public static function factory( $displayFormat/*, $arguments...*/ ) {
@@ -1359,7 +1358,7 @@ 
 	 * this message as its "<legend>" element.
 	 * @since 1.19
 	 *
-	 * @param string|Message $msg Message key or Message object
+	 * @param string $msg Message key or Message object
 	 *
 	 * @return HTMLForm $this for chaining calls (since 1.20)
 	 */

includes/htmlform/HTMLFormField.php

Doc Comments +9 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
 	 * Defaults to false, which getOOUI will interpret as "use the HTML version"
 	 *
 	 * @param string $value
-	 * @return OOUI\Widget|false
+	 * @return boolean
 	 */
 	function getInputOOUI( $value ) {
 		return false;
@@ -318,6 +318,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param HTMLFormField[] $alldata
+	 */
 	function filter( $value, $alldata ) {
 		if ( isset( $this->mFilterCallback ) ) {
 			$value = call_user_func( $this->mFilterCallback, $value, $alldata, $this->mParent );
@@ -803,7 +806,7 @@ 
 	 * @since 1.20
 	 *
 	 * @param string $value The value of the input
-	 * @return array array( $errors, $errorClass )
+	 * @return string[] array( $errors, $errorClass )
 	 */
 	public function getErrorsAndErrorClass( $value ) {
 		$errors = $this->validate( $value, $this->mParent->mFieldData );
@@ -891,6 +894,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @return string
+	 */
 	function getDefault() {
 		if ( isset( $this->mDefault ) ) {
 			return $this->mDefault;
@@ -1086,7 +1092,7 @@ 
 	/**
 	 * Formats one or more errors as accepted by field validation-callback.
 	 *
-	 * @param string|Message|array $errors Array of strings or Message instances
+	 * @param string $errors Array of strings or Message instances
 	 * @return string HTML
 	 * @since 1.18
 	 */

includes/htmlform/HTMLMultiSelectField.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
 		return $html;
 	}
 
+	/**
+	 * @param boolean $checked
+	 */
 	protected function getOneCheckbox( $checked, $attribs, $label ) {
 		if ( $this->mParent instanceof OOUIHTMLForm ) {
 			if ( $this->mOptionsLabelsNotFromMessage ) {

includes/htmlform/HTMLRadioField.php

Doc Comments +3 added lines

@@ -55,6 +55,9 @@
 		) + $this->getAttributes( array( 'disabled', 'tabindex' ), array( 'tabindex' => 'tabIndex' ) ) );
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function formatOptions( $options, $value ) {
 		$html = '';
 

includes/htmlform/OOUIHTMLForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
 	 * @param OOUI\FieldLayout[] $fieldsHtml
 	 * @param string $sectionName
 	 * @param bool $anyFieldHasLabel Unused
-	 * @return string HTML
+	 * @return OOUI\FieldsetLayout HTML
 	 */
 	protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
 		$config = array(