From: Sam Reed <reedy@users.mediawiki.org>
Date: Thu, 23 Dec 2010 19:24:38 +0000 (+0000)
Subject: Add some method documentation
X-Git-Tag: 1.31.0-rc.0~33142
X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dmembres/cotisations/voir.php?a=commitdiff_plain;h=5ab6724f06edfe818f0d5851cca257253184047d;p=lhc%2Fweb%2Fwiklou.git

Add some method documentation
---

diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php
index 0897e4b4c2..c5170c4fa6 100644
--- a/includes/api/ApiHelp.php
+++ b/includes/api/ApiHelp.php
@@ -93,6 +93,11 @@ class ApiHelp extends ApiBase {
 		$result->addValue( null, $this->getModuleName(), $r );
 	}
 
+	/**
+	 * @param  $module ApiBase
+	 * @param  $type String What type of request is this? e.g. action, query, list, prop, meta, format
+	 * @return string
+	 */
 	private function buildModuleHelp( $module, $type ) {
 		$msg = ApiMain::makeHelpMsgHeader( $module, $type );
 
diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index d1d7214917..24be819651 100644
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -867,6 +867,12 @@ class ApiMain extends ApiBase {
 		return $msg;
 	}
 
+	/**
+	 * @static
+	 * @param  $module ApiBase
+	 * @param  $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
+	 * @return string
+	 */
 	public static function makeHelpMsgHeader( $module, $paramName ) {
 		$modulePrefix = $module->getModulePrefix();
 		if ( strval( $modulePrefix ) !== '' ) {