Thiemo Mättig (WMDE) has uploaded a new change for review.
https://gerrit.wikimedia.org/r/235447
Change subject: Fix incomplete PHPDoc tags in ApiBase
......................................................................
Fix incomplete PHPDoc tags in ApiBase
Change-Id: Icb388723e51c8b07fee3900b98795cfe623942ac
---
M includes/api/ApiBase.php
1 file changed, 22 insertions(+), 5 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/47/235447/1
diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 393ff49..7cb799f 100644
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -1339,8 +1339,9 @@
* @param string $errorCode Brief, arbitrary, stable string to allow
easy
* automated identification of the error, e.g., 'unknown_action'
* @param int $httpRespCode HTTP response code
- * @param array $extradata Data to add to the "<error>" element; array
in ApiResult format
- * @throws UsageException
+ * @param array|null $extradata Data to add to the "<error>" element;
array in ApiResult format
+ *
+ * @throws UsageException always
*/
public function dieUsage( $description, $errorCode, $httpRespCode = 0,
$extradata = null ) {
throw new UsageException(
@@ -1395,11 +1396,12 @@
* Throw a UsageException based on the errors in the Status object.
*
* @since 1.22
+ *
* @param Status $status
- * @throws MWException
+ *
+ * @throws UsageException always
*/
public function dieStatus( $status ) {
-
list( $code, $msg ) = $this->getErrorFromStatus( $status );
$this->dieUsage( $msg, $code );
}
@@ -1913,6 +1915,8 @@
/**
* Helper function for readonly errors
+ *
+ * @throws UsageException always
*/
public function dieReadOnly() {
$parsed = $this->parseMsg( array( 'readonlytext' ) );
@@ -1922,7 +1926,10 @@
/**
* Output the error message related to a certain array
+ *
* @param array|string $error Element of a
getUserPermissionsErrors()-style array
+ *
+ * @throws UsageException always
*/
public function dieUsageMsg( $error ) {
# most of the time we send a 1 element, so we might as well
send it as
@@ -1937,8 +1944,12 @@
/**
* Will only set a warning instead of failing if the global $wgDebugAPI
* is set to true. Otherwise behaves exactly as dieUsageMsg().
+ *
* @param array|string $error Element of a
getUserPermissionsErrors()-style array
+ *
* @since 1.21
+ *
+ * @throws UsageException
*/
public function dieUsageMsgOrDebug( $error ) {
if ( $this->getConfig()->get( 'DebugAPI' ) !== true ) {
@@ -1955,8 +1966,12 @@
/**
* Die with the $prefix.'badcontinue' error. This call is common enough
to
* make it into the base method.
+ *
* @param bool $condition Will only die if this value is true
+ *
* @since 1.21
+ *
+ * @throws UsageException
*/
protected function dieContinueUsageIf( $condition ) {
if ( $condition ) {
@@ -1995,9 +2010,11 @@
/**
* Internal code errors should be reported with this method
+ *
* @param string $method Method or function name
* @param string $message Error message
- * @throws MWException
+ *
+ * @throws MWException always
*/
protected static function dieDebug( $method, $message ) {
throw new MWException( "Internal error in $method: $message" );
--
To view, visit https://gerrit.wikimedia.org/r/235447
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Icb388723e51c8b07fee3900b98795cfe623942ac
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
