From 0a787f60ac474c3cd2f2e139cf377e160a69dbdf Mon Sep 17 00:00:00 2001 From: Reedy Date: Sat, 7 Nov 2015 21:25:04 +0000 Subject: [PATCH] Add/update phpdoc Change-Id: I9cb6f041a0242c3257a24aac6538f7fbbca60cb0 --- includes/api/ApiContinuationManager.php | 1 + includes/api/ApiMessage.php | 1 - includes/api/ApiOpenSearch.php | 2 +- includes/api/ApiResult.php | 7 ++++--- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/includes/api/ApiContinuationManager.php b/includes/api/ApiContinuationManager.php index 354f4e7de1..74d0352a4f 100644 --- a/includes/api/ApiContinuationManager.php +++ b/includes/api/ApiContinuationManager.php @@ -39,6 +39,7 @@ class ApiContinuationManager { * @param ApiBase $module Module starting the continuation * @param ApiBase[] $allModules Contains ApiBase instances that will be executed * @param array $generatedModules Names of modules that depend on the generator + * @throws UsageException */ public function __construct( ApiBase $module, array $allModules = array(), array $generatedModules = array() diff --git a/includes/api/ApiMessage.php b/includes/api/ApiMessage.php index 370911abd9..5c3434f95c 100644 --- a/includes/api/ApiMessage.php +++ b/includes/api/ApiMessage.php @@ -172,7 +172,6 @@ class ApiRawMessage extends RawMessage implements IApiMessage { * - string: passed to RawMessage::__construct * @param string|null $code * @param array|null $data - * @return ApiMessage */ public function __construct( $msg, $code = null, array $data = null ) { if ( $msg instanceof RawMessage ) { diff --git a/includes/api/ApiOpenSearch.php b/includes/api/ApiOpenSearch.php index f25f2d3833..5ce43ccead 100644 --- a/includes/api/ApiOpenSearch.php +++ b/includes/api/ApiOpenSearch.php @@ -311,7 +311,7 @@ class ApiOpenSearch extends ApiBase { * Extension:ActiveAbstract. * * @param string $text - * @param int $len Target length; actual result will continue to the end of a sentence. + * @param int $length Target length; actual result will continue to the end of a sentence. * @return string */ public static function trimExtract( $text, $length ) { diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php index 3468cf69fd..e28cb82703 100644 --- a/includes/api/ApiResult.php +++ b/includes/api/ApiResult.php @@ -327,6 +327,7 @@ class ApiResult implements ApiSerializable { /** * Validate a value for addition to the result * @param mixed $value + * @return array|mixed|string */ private static function validateValue( $value ) { global $wgContLang; @@ -738,7 +739,7 @@ class ApiResult implements ApiSerializable { * Set the array data type for a path * @since 1.25 * @param array|string|null $path See ApiResult::addValue() - * @param string $type See ApiResult::META_TYPE + * @param string $tag See ApiResult::META_TYPE * @param string $kvpKeyName See ApiResult::META_KVP_KEY_NAME */ public function addArrayType( $path, $tag, $kvpKeyName = null ) { @@ -766,7 +767,7 @@ class ApiResult implements ApiSerializable { * Set the array data type for a path recursively * @since 1.25 * @param array|string|null $path See ApiResult::addValue() - * @param string $type See ApiResult::META_TYPE + * @param string $tag See ApiResult::META_TYPE * @param string $kvpKeyName See ApiResult::META_KVP_KEY_NAME */ public function addArrayTypeRecursive( $path, $tag, $kvpKeyName = null ) { @@ -796,7 +797,7 @@ class ApiResult implements ApiSerializable { * * @see ApiResult::getResultData() * @since 1.25 - * @param array $data + * @param array $dataIn * @param array $transforms * @return array|object */ -- 2.20.1