wikimedia / mediawiki

includes/api/ApiBase.php

Doc Comments +14 added lines, -10 removed lines

@@ -408,7 +408,7 @@ 
 	 * Returning true will generate errors indicating that the API module needs
 	 * updating.
 	 *
-	 * @return string|false
+	 * @return boolean
 	 */
 	public function needsToken() {
 		return false;
@@ -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;
@@ -437,7 +437,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|bool|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;
@@ -486,7 +486,7 @@ 
 	/**
 	 * Get the parent of this module
 	 * @since 1.25
-	 * @return ApiBase|null
+	 * @return ApiMain
 	 */
 	public function getParent() {
 		return $this->isMain() ? null : $this->getMain();
@@ -621,6 +621,7 @@ 
 	/**
 	 * Set the continuation manager
 	 * @param ApiContinuationManager|null
+	 * @param ApiContinuationManager|null $manager
 	 */
 	public function setContinuationManager( $manager ) {
 		// Main module has setContinuationManager() method overridden
@@ -704,6 +705,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();
@@ -730,6 +732,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();
@@ -753,6 +756,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();
@@ -2531,7 +2535,7 @@ 
 	 * "apihelp-{$this->getModulePath()}-description".
 	 *
 	 * @deprecated since 1.25
-	 * @return Message|string|array
+	 * @return boolean
 	 */
 	protected function getDescription() {
 		return false;
@@ -2567,7 +2571,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;
@@ -2576,7 +2580,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' );
@@ -2686,7 +2690,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' );
@@ -2877,7 +2881,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileTime() {
 		wfDeprecated( __METHOD__, '1.25' );
@@ -2900,7 +2904,7 @@ 
 
 	/**
 	 * @deprecated since 1.25, always returns 0
-	 * @return float
+	 * @return integer
 	 */
 	public function getProfileDBTime() {
 		wfDeprecated( __METHOD__, '1.25' );

includes/Revision.php

Doc Comments +9 added lines, -9 removed lines

@@ -423,7 +423,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectFields() {
 		global $wgContentHandlerUseDB;
@@ -454,7 +454,7 @@ 
 	/**
 	 * Return the list of revision fields that should be selected to create
 	 * a new revision from an archive row.
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectArchiveFields() {
 		global $wgContentHandlerUseDB;
@@ -485,7 +485,7 @@ 
 	/**
 	 * Return the list of text fields that should be selected to read the
 	 * revision text
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectTextFields() {
 		return [
@@ -496,7 +496,7 @@ 
 
 	/**
 	 * Return the list of page fields that should be selected from page table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectPageFields() {
 		return [
@@ -511,7 +511,7 @@ 
 
 	/**
 	 * Return the list of user fields that should be selected from user table
-	 * @return array
+	 * @return string[]
 	 */
 	public static function selectUserFields() {
 		return [ 'user_name' ];
@@ -756,7 +756,7 @@ 
 	/**
 	 * Returns the base36 sha1 of the text in this revision, or null if unknown.
 	 *
-	 * @return string|null
+	 * @return string
 	 */
 	public function getSha1() {
 		return $this->mSha1;
@@ -838,7 +838,7 @@ 
 	/**
 	 * Fetch revision's user id without regard for the current user's permissions
 	 *
-	 * @return string
+	 * @return integer
 	 * @deprecated since 1.25, use getUser( Revision::RAW )
 	 */
 	public function getRawUser() {
@@ -1758,7 +1758,7 @@ 
 	 *
 	 * @param Title $title
 	 * @param int $id
-	 * @return string|bool False if not found
+	 * @return string|false False if not found
 	 */
 	static function getTimestampFromId( $title, $id, $flags = 0 ) {
 		$db = ( $flags & self::READ_LATEST )
@@ -1814,7 +1814,7 @@ 
 	 * @since 1.20
 	 * @deprecated since 1.24
 	 *
-	 * @param IDatabase|int $db The Database to perform the check on. May be given as a
+	 * @param integer $db The Database to perform the check on. May be given as a
 	 *        Database object or a database identifier usable with wfGetDB.
 	 * @param int $pageId The ID of the page in question
 	 * @param int $userId The ID of the user in question