From 32eb80c15c320e1101655090cdc6e923426c5536 Mon Sep 17 00:00:00 2001
From: Sam Reed <reedy@users.mediawiki.org>
Date: Sun, 30 Jan 2011 08:16:13 +0000
Subject: [PATCH] A few return type hints

---
 includes/api/ApiMain.php | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index e71c5e1fc3..72b18ebb1c 100644
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -180,6 +180,7 @@ class ApiMain extends ApiBase {
 
 	/**
 	 * Return true if the API was started by other PHP code using FauxRequest
+	 * @return bool
 	 */
 	public function isInternalMode() {
 		return $this->mInternalMode;
@@ -204,6 +205,8 @@ class ApiMain extends ApiBase {
 
 	/**
 	 * Get the API module object. Only works after executeAction()
+	 *
+	 * @return ApiBase
 	 */
 	public function getModule() {
 		return $this->mModule;
@@ -309,6 +312,8 @@ class ApiMain extends ApiBase {
 
 	/**
 	 * Create an instance of an output formatter by its name
+	 *
+	 * @return ApiFormatBase
 	 */
 	public function createPrinterByName( $format ) {
 		if ( !isset( $this->mFormats[$format] ) ) {
@@ -455,6 +460,7 @@ class ApiMain extends ApiBase {
 	 * Replace the result data with the information about an exception.
 	 * Returns the error code
 	 * @param $e Exception
+	 * @return string
 	 */
 	protected function substituteResultWithError( $e ) {
 		// Printer may not be initialized if the extractRequestParams() fails for the main module
@@ -516,6 +522,7 @@ class ApiMain extends ApiBase {
 
 	/**
 	 * Set up for the execution.
+	 * @return array
 	 */
 	protected function setupExecuteAction() {
 		// First add the id to the top element
@@ -692,6 +699,9 @@ class ApiMain extends ApiBase {
 		$printer->profileOut();
 	}
 
+	/**
+	 * @return bool
+	 */
 	public function isReadMode() {
 		return false;
 	}
@@ -977,6 +987,7 @@ class ApiMain extends ApiBase {
 
 	/**
 	 * Get the array mapping module names to class names
+	 * @return array
 	 */
 	function getModules() {
 		return $this->mModules;
-- 
2.20.1