From 1374c143a6664a498083722b709011288af3c7ab Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Fri, 24 Feb 2012 18:38:04 +0000 Subject: [PATCH] Improve documentation --- includes/api/ApiBase.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 9a62780d3e..fbdf9716e9 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -533,7 +533,7 @@ abstract class ApiBase extends ContextSource { * Returns an array of parameter descriptions. * Don't call this functon directly: use getFinalParamDescription() to * allow hooks to modify descriptions as needed. - * @return array or false + * @return array|bool False on no parameter descriptions */ protected function getParamDescription() { return false; @@ -543,7 +543,7 @@ abstract class ApiBase extends ContextSource { * Get final list of parameters, after hooks have had a chance to * tweak it as needed. * - * @return array or false + * @return array|Bool False on no parameters */ public function getFinalParams() { $params = $this->getAllowedParams(); @@ -555,7 +555,7 @@ abstract class ApiBase extends ContextSource { * Get final parameter descriptions, after hooks have had a chance to tweak it as * needed. * - * @return array + * @return array|bool False on no parameter descriptions */ public function getFinalParamDescription() { $desc = $this->getParamDescription(); @@ -567,7 +567,7 @@ abstract class ApiBase extends ContextSource { * Get final module description, after hooks have had a chance to tweak it as * needed. * - * @return array + * @return array|bool False on no parameters */ public function getFinalDescription() { $desc = $this->getDescription(); -- 2.20.1