wikimedia / mediawiki

includes/actions/FormAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
 
 	/**
 	 * Get the HTMLForm to control behavior
-	 * @return HTMLForm|null
+	 * @return HTMLForm
 	 */
 	protected function getForm() {
 		$this->fields = $this->getFormFields();

includes/actions/HistoryAction.php

Doc Comments +4 added lines

@@ -523,6 +523,10 @@
 		return $s;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $msg
+	 */
 	private function getRevisionButton( $name, $msg ) {
 		$this->preventClickjacking();
 		# Note bug #20966, <button> is non-standard in IE<8

includes/api/ApiBase.php

Doc Comments +15 added lines, -11 removed lines

@@ -406,7 +406,7 @@ 
 	 * Returning true will generate errors indicating that the API module needs
 	 * updating.
 	 *
-	 * @return string|false
+	 * @return boolean
 	 */
 	public function needsToken() {
 		return false;
@@ -419,7 +419,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;
@@ -435,7 +435,7 @@ 
 	 *    RFC 7232 § 2.2 for semantics.
 	 *  - etag: Return an entity-tag representing the state of all resources involved
 	 *    in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.
-	 * @return string|boolean|null As described above, or null if no value is available.
+	 * @return string As described above, or null if no value is available.
 	 */
 	public function getConditionalRequestData( $condition ) {
 		return null;
@@ -484,7 +484,7 @@ 
 	/**
 	 * Get the parent of this module
 	 * @since 1.25
-	 * @return ApiBase|null
+	 * @return ApiMain
 	 */
 	public function getParent() {
 		return $this->isMain() ? null : $this->getMain();
@@ -619,6 +619,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -692,6 +693,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();
@@ -718,6 +720,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();
@@ -741,6 +744,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();
@@ -2533,7 +2537,7 @@ 
 	 * has been removed.
 	 *
 	 * @deprecated since 1.24
-	 * @return array|bool
+	 * @return boolean
 	 */
 	protected function getResultProperties() {
 		wfDeprecated( __METHOD__, '1.24' );
@@ -2640,7 +2644,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2676,7 +2680,7 @@ 
 	 * that value, and boolean false means "no examples".
 	 *
 	 * @deprecated since 1.25, use getExamplesMessages() instead
-	 * @return bool|string|array
+	 * @return boolean
 	 */
 	protected function getExamples() {
 		return false;
@@ -2685,7 +2689,7 @@ 
 	/**
 	 * Generates help message for this module, or false if there is no description
 	 * @deprecated since 1.25
-	 * @return string|bool
+	 * @return string
 	 */
 	public function makeHelpMsg() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2795,7 +2799,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' );
@@ -2986,7 +2990,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -3009,7 +3013,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/api/ApiErrorFormatter.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 	/**
 	 * Add a warning to the result
 	 * @param string $moduleName
-	 * @param MessageSpecifier|array|string $msg i18n message for the warning
+	 * @param ApiRawMessage $msg i18n message for the warning
 	 * @param string $code Machine-readable code for the warning. Defaults as
 	 *   for IApiMessage::getApiCode().
 	 * @param array $data Machine-readable data for the warning, if any.
@@ -181,7 +181,7 @@ 
 	 * Actually add the warning or error to the result
 	 * @param string $tag 'warning' or 'error'
 	 * @param string $moduleName
-	 * @param ApiMessage|ApiRawMessage $msg
+	 * @param Message $msg
 	 */
 	protected function addWarningOrError( $tag, $moduleName, $msg ) {
 		$value = array( 'code' => $msg->getApiCode() );

includes/api/ApiFormatXml.php

Doc Comments +3 added lines

@@ -39,6 +39,9 @@
 		return 'text/xml';
 	}
 
+	/**
+	 * @param string $rootElemName
+	 */
 	public function setRootElement( $rootElemName ) {
 		$this->mRootElemName = $rootElemName;
 	}

includes/api/ApiMain.php

Doc Comments +1 added lines, -1 removed lines

@@ -1683,7 +1683,7 @@
 
 	/**
 	 * @deprecated since 1.25
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function reallyMakeHelpMsg() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/api/ApiMessage.php

Doc Comments +2 added lines

@@ -53,12 +53,14 @@
 	 * Sets the machine-readable code for use by the API
 	 * @param string|null $code If null, the message key should be returned by self::getApiCode()
 	 * @param array|null $data If non-null, passed to self::setApiData()
+	 * @return void
 	 */
 	public function setApiCode( $code, array $data = null );
 
 	/**
 	 * Sets additional machine-readable data about the error condition
 	 * @param array $data
+	 * @return void
 	 */
 	public function setApiData( array $data );
 }

includes/api/ApiOpenSearch.php

Doc Comments +3 added lines

@@ -377,6 +377,9 @@
 class ApiOpenSearchFormatJson extends ApiFormatJson {
 	private $warningsAsError = false;
 
+	/**
+	 * @param string $fm
+	 */
 	public function __construct( ApiMain $main, $fm, $warningsAsError ) {
 		parent::__construct( $main, "json$fm" );
 		$this->warningsAsError = $warningsAsError;

includes/api/ApiPageSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -576,7 +576,7 @@
 	/**
 	 * Get an array of invalid/special/missing titles.
 	 *
-	 * @param array $invalidChecks List of types of invalid titles to include.
+	 * @param string[] $invalidChecks List of types of invalid titles to include.
 	 *   Recognized values are:
 	 *   - invalidTitles: Titles and reasons from $this->getInvalidTitlesAndReasons()
 	 *   - special: Titles from $this->getSpecialTitles()