wikimedia / mediawiki

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/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()

includes/api/ApiParse.php

Doc Comments +1 added lines, -1 removed lines

@@ -560,7 +560,7 @@
 	 *
 	 * @param Title $title of the page being parsed
 	 * @param Array $params the API parameters of the request
-	 * @return Content|bool
+	 * @return string
 	 */
 	private function formatSummary( $title, $params ) {
 		global $wgParser;

includes/api/ApiQueryCategoryMembers.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
 
 	/**
 	 * @param string $hexSortkey
-	 * @return bool
+	 * @return integer
 	 */
 	private function validateHexSortkey( $hexSortkey ) {
 		// A hex sortkey has an unbound number of 2 letter pairs

includes/api/ApiQueryExtLinksUsage.php

Doc Comments +3 added lines

@@ -202,6 +202,9 @@
 		return $protocols;
 	}
 
+	/**
+	 * @return string|null
+	 */
 	public static function getProtocolPrefix( $protocol ) {
 		// Find the right prefix
 		global $wgUrlProtocols;

includes/api/ApiResult.php

Doc Comments +4 added lines, -4 removed lines

@@ -469,7 +469,7 @@ 
 	 *
 	 * @since 1.25
 	 * @param array &$arr To add $value to
-	 * @param string|int $name Index of $arr to add $value at.
+	 * @param string $name Index of $arr to add $value at.
 	 * @param mixed $value
 	 * @param int $flags Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.
 	 */
@@ -486,10 +486,10 @@ 
 	 *
 	 * @since 1.25
 	 * @param array|string|null $path See ApiResult::addValue()
-	 * @param string|int $name See ApiResult::setValue()
+	 * @param string $name See ApiResult::setValue()
 	 * @param mixed $value
 	 * @param int $flags Zero or more OR-ed flags like OVERRIDE | ADD_ON_TOP.
-	 * @return bool True if $value fits in the result, false if not
+	 * @return boolean|null True if $value fits in the result, false if not
 	 */
 	public function addContentValue( $path, $name, $value, $flags = 0 ) {
 		if ( $name === null ) {
@@ -573,7 +573,7 @@ 
 	 * subelements rather than attributes.
 	 * @since 1.25
 	 * @param array|string|null $path See ApiResult::addValue()
-	 * @param array|string|int $names The element name(s) to be output as subelements
+	 * @param string $names The element name(s) to be output as subelements
 	 */
 	public function addSubelementsList( $path, $names ) {
 		$arr = &$this->path( $path );