r112338 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r112337‎ | r112338 | r112339 >
Date:18:38, 24 February 2012
Author:reedy
Status:ok
Tags:
Comment:
Improve documentation
Modified paths:
  • /trunk/phase3/includes/api/ApiBase.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiBase.php
@@ -533,7 +533,7 @@
534534 * Returns an array of parameter descriptions.
535535 * Don't call this functon directly: use getFinalParamDescription() to
536536 * allow hooks to modify descriptions as needed.
537 - * @return array or false
 537+ * @return array|bool False on no parameter descriptions
538538 */
539539 protected function getParamDescription() {
540540 return false;
@@ -543,7 +543,7 @@
544544 * Get final list of parameters, after hooks have had a chance to
545545 * tweak it as needed.
546546 *
547 - * @return array or false
 547+ * @return array|Bool False on no parameters
548548 */
549549 public function getFinalParams() {
550550 $params = $this->getAllowedParams();
@@ -555,7 +555,7 @@
556556 * Get final parameter descriptions, after hooks have had a chance to tweak it as
557557 * needed.
558558 *
559 - * @return array
 559+ * @return array|bool False on no parameter descriptions
560560 */
561561 public function getFinalParamDescription() {
562562 $desc = $this->getParamDescription();
@@ -567,7 +567,7 @@
568568 * Get final module description, after hooks have had a chance to tweak it as
569569 * needed.
570570 *
571 - * @return array
 571+ * @return array|bool False on no parameters
572572 */
573573 public function getFinalDescription() {
574574 $desc = $this->getDescription();

Status & tagging log