r103920 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r103919‎ | r103920 | r103921 >
Date:16:31, 22 November 2011
Author:reedy
Status:ok
Tags:
Comment:
Few bits of documentation
Modified paths:
  • /trunk/phase3/includes/installer/Installer.php (modified) (history)
  • /trunk/phase3/includes/installer/WebInstaller.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/installer/WebInstaller.php
@@ -1068,6 +1068,9 @@
10691069 return Html::rawElement( 'div', array( 'class' => 'config-download-link' ), $anchor );
10701070 }
10711071
 1072+ /**
 1073+ * @return bool
 1074+ */
10721075 public function envCheckPath( ) {
10731076 // PHP_SELF isn't available sometimes, such as when PHP is CGI but
10741077 // cgi.fix_pathinfo is disabled. In that case, fall back to SCRIPT_NAME
@@ -1085,9 +1088,6 @@
10861089 $this->showError( 'config-no-uri' );
10871090 return false;
10881091 }
1089 -
1090 -
10911092 return parent::envCheckPath();
10921093 }
1093 -
10941094 }
Index: trunk/phase3/includes/installer/Installer.php
@@ -296,11 +296,13 @@
297297 * The parameters are like parameters to wfMsg().
298298 * The messages will be in wikitext format, which will be converted to an
299299 * output format such as HTML or text before being sent to the user.
 300+ * @param $msg
300301 */
301302 public abstract function showMessage( $msg /*, ... */ );
302303
303304 /**
304305 * Same as showMessage(), but for displaying errors
 306+ * @param $msg
305307 */
306308 public abstract function showError( $msg /*, ... */ );
307309
@@ -621,6 +623,7 @@
622624
623625 /**
624626 * Environment check for DB types.
 627+ * @return bool
625628 */
626629 protected function envCheckDB() {
627630 global $wgLang;
@@ -865,6 +868,7 @@
866869
867870 /**
868871 * Environment check for setting $IP and $wgScriptPath.
 872+ * @return bool
869873 */
870874 protected function envCheckPath() {
871875 global $IP;
@@ -890,6 +894,7 @@
891895
892896 /**
893897 * TODO: document
 898+ * @return bool
894899 */
895900 protected function envCheckShellLocale() {
896901 $os = php_uname( 's' );
@@ -1475,6 +1480,9 @@
14761481 return $status;
14771482 }
14781483
 1484+ /**
 1485+ * @param $s Status
 1486+ */
14791487 private function subscribeToMediaWikiAnnounce( Status $s ) {
14801488 $params = array(
14811489 'email' => $this->getVar( '_AdminEmail' ),

Status & tagging log