r78913 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r78912‎ | r78913 | r78914 >
Date:19:24, 23 December 2010
Author:reedy
Status:ok
Tags:
Comment:
Add some method documentation
Modified paths:
  • /trunk/phase3/includes/api/ApiHelp.php (modified) (history)
  • /trunk/phase3/includes/api/ApiMain.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiMain.php
@@ -867,6 +867,12 @@
868868 return $msg;
869869 }
870870
 871+ /**
 872+ * @static
 873+ * @param $module ApiBase
 874+ * @param $paramName String What type of request is this? e.g. action, query, list, prop, meta, format
 875+ * @return string
 876+ */
871877 public static function makeHelpMsgHeader( $module, $paramName ) {
872878 $modulePrefix = $module->getModulePrefix();
873879 if ( strval( $modulePrefix ) !== '' ) {
Index: trunk/phase3/includes/api/ApiHelp.php
@@ -93,6 +93,11 @@
9494 $result->addValue( null, $this->getModuleName(), $r );
9595 }
9696
 97+ /**
 98+ * @param $module ApiBase
 99+ * @param $type String What type of request is this? e.g. action, query, list, prop, meta, format
 100+ * @return string
 101+ */
97102 private function buildModuleHelp( $module, $type ) {
98103 $msg = ApiMain::makeHelpMsgHeader( $module, $type );
99104

Status & tagging log