Fixed some doxygen warnings
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 9 May 2010 14:06:36 +0000 (14:06 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sun, 9 May 2010 14:06:36 +0000 (14:06 +0000)
includes/installer/Installer.php
includes/installer/InstallerDBType.php

index 5cafed9..d055e0e 100644 (file)
@@ -545,9 +545,9 @@ abstract class Installer {
         * executable name if found. Also checks the version string returned 
         * by each executable
         *
-        * @param string $path Path to search
-        * @param array $names Array of executable names
-        * @param string $versionInfo Array with two members:
+        * @param $path String: path to search
+        * @param $names Array of executable names
+        * @param $versionInfo Boolean false or array with two members:
         *       0 => Command to run for version check, with $1 for the path
         *       1 => String to compare the output with
         *
@@ -770,8 +770,9 @@ abstract class Installer {
         * whatever, this function is guarded to catch attempted DB access and to present 
         * some fallback text.
         *
-        * @param string $text
-        * @return string
+        * @param $text String
+        * @param $lineStart Boolean
+        * @return String
         */
        function parse( $text, $lineStart = false ) {
                global $wgParser;
@@ -919,7 +920,7 @@ abstract class Installer {
         *
         * Public because SqliteInstaller needs it, and doesn't subclass Installer.
         *
-        * @return string
+        * @return String
         */
        public static function maybeGetWebserverPrimaryGroup() {
                if ( ! function_exists('posix_getegid') || ! function_exists('posix_getpwuid') ) {
index 93f1d4e..2b03d63 100644 (file)
@@ -226,7 +226,7 @@ abstract class InstallerDBType {
        /**
         * Get a set of labelled radio buttons
         *
-        * @param array $params
+        * @param $params Array:
         *    Parameters are:
         *      var:            The variable to be configured (required)
         *      label:          The message name for the label (required)
@@ -245,7 +245,7 @@ abstract class InstallerDBType {
         * Convenience function to set variables based on form data.
         * Assumes that variables containing "password" in the name are (potentially
         * fake) passwords.
-        * @param array $varNames
+        * @param $varNames Array
         */
        function setVarsFromRequest( $varNames ) {
                return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
@@ -259,7 +259,7 @@ abstract class InstallerDBType {
         * Traditionally, this is done by testing for the existence of either 
         * the revision table or the cur table.
         *
-        * @return boolean
+        * @return Boolean
         */
        function needsUpgrade() {
                $status = $this->getConnection();
@@ -296,7 +296,7 @@ abstract class InstallerDBType {
 
        /**
         * Get a standard web-user fieldset
-        * @param string $noCreateMsg Message to display instead of the creation checkbox. 
+        * @param $noCreateMsg String: Message to display instead of the creation checkbox.
         *   Set this to false to show a creation checkbox.
         */
        function getWebUserBox( $noCreateMsg = false ) {