Add some method documentation

diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php
index 0897e4b..c5170c4 100644 (file)
--- 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 d1d7214..24be819 100644 (file)
--- 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 ) !== '' ) {