diff options
| author | Umherirrender <umherirrender_de.wp@web.de> | 2020-11-12 22:37:48 +0100 |
|---|---|---|
| committer | Umherirrender <umherirrender_de.wp@web.de> | 2020-11-13 23:11:06 +0100 |
| commit | 083a0e57cb401477d81a4eac7a3525c1637c8f44 (patch) | |
| tree | 682c95fab7b37a6d45b0c51737504dd7e52489e2 /includes/api/ApiBase.php | |
| parent | 197628383571f7224003682fc238b057e907689d (diff) | |
| download | mediawikicore-083a0e57cb401477d81a4eac7a3525c1637c8f44.tar.gz mediawikicore-083a0e57cb401477d81a4eac7a3525c1637c8f44.zip | |
Improve docs in api related classes
Change-Id: I78338d48530f098fa5d36fe84cfd45c0d160f444
Diffstat (limited to 'includes/api/ApiBase.php')
| -rw-r--r-- | includes/api/ApiBase.php | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 292312cff171..e3ad6cb7f166 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -182,7 +182,7 @@ abstract class ApiBase extends ContextSource { /** @var stdClass[][] Cache for self::filterIDs() */ private static $filterIDsCache = []; - /** $var array Map of web UI block messages to corresponding API messages and codes */ + /** @var array Map of web UI block messages to corresponding API messages and codes */ private static $blockMsgMap = [ 'blockedtext' => [ 'apierror-blocked', 'blocked' ], 'blockedtext-partial' => [ 'apierror-blocked-partial', 'blocked' ], @@ -200,7 +200,7 @@ abstract class ApiBase extends ContextSource { * @var array */ private $mParamCache = []; - /** @var array|null|bool */ + /** @var array|null|false */ private $mModuleSource = false; /** @@ -961,7 +961,7 @@ abstract class ApiBase extends ContextSource { /** * Callback function used in requireOnlyOneParameter to check whether required parameters are set * - * @param object $x Parameter to check is not null/false + * @param mixed $x Parameter to check is not null/false * @return bool */ private function parameterNotEmpty( $x ) { @@ -973,7 +973,7 @@ abstract class ApiBase extends ContextSource { * Can die, if no param is set or if the title or page id is not valid. * * @param array $params User provided set of parameters, as from $this->extractRequestParams() - * @param bool|string $load Whether load the object's state from the database: + * @param string|false $load Whether load the object's state from the database: * - false: don't load (if the pageid is given, it will still be loaded) * - 'fromdb': load from a replica DB * - 'fromdbmaster': load from the master database @@ -1694,7 +1694,7 @@ abstract class ApiBase extends ContextSource { * tweak it as needed. * * @param int $flags Zero or more flags like GET_VALUES_FOR_HELP - * @return array|bool False on no parameters + * @return array * @since 1.21 $flags param added */ public function getFinalParams( $flags = 0 ) { |