Fixup some more documentation

diff --git a/includes/Article.php b/includes/Article.php
index 3d46f6b..5b0e1c2 100644 (file)
--- a/includes/Article.php
+++ b/includes/Article.php
@@ -1758,7 +1758,7 @@ class Article {
        /**
         * Update the page record to point to a newly saved revision.
         *
-        * @param $dbw Database object
+        * @param $dbw DatabaseBase: object
         * @param $revision Revision: For ID number, and text used to set
                            length and redirect status fields
         * @param $lastRevision Integer: if given, will not overwrite the page field
@@ -3609,12 +3609,12 @@ class Article {
         * Every 100th edit, prune the recent changes table.
         *
         * @private
-        * @param $text New text of the article
-        * @param $summary Edit summary
-        * @param $minoredit Minor edit
+        * @param $text String: New text of the article
+        * @param $summary String: Edit summary
+        * @param $minoredit Boolean: Minor edit
         * @param $timestamp_of_pagechange Timestamp associated with the page change
-        * @param $newid rev_id value of the new revision
-        * @param $changed Whether or not the content actually changed
+        * @param $newid Integer: rev_id value of the new revision
+        * @param $changed Boolean: Whether or not the content actually changed
         */
        public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
                global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;

diff --git a/includes/ImageGallery.php b/includes/ImageGallery.php
index 281cac2..b768073 100644 (file)
--- a/includes/ImageGallery.php
+++ b/includes/ImageGallery.php
@@ -76,7 +76,7 @@ class ImageGallery
        /**
         * Set the caption (as HTML)
         *
-        * @param $caption Caption
+        * @param $caption String: Caption
         */
        public function setCaptionHtml( $caption ) {
                $this->mCaption = $caption;

diff --git a/includes/Revision.php b/includes/Revision.php
index e2eed75..8096603 100644 (file)
--- a/includes/Revision.php
+++ b/includes/Revision.php
@@ -798,7 +798,7 @@ class Revision {
         * Insert a new revision into the database, returning the new revision ID
         * number on success and dies horribly on failure.
         *
-        * @param $dbw DatabaseBase (master connection)
+        * @param $dbw DatabaseBase: (master connection)
         * @return Integer
         */
        public function insertOn( $dbw ) {

diff --git a/includes/Title.php b/includes/Title.php
index 24e1212..a772f3c 100644 (file)
--- a/includes/Title.php
+++ b/includes/Title.php
@@ -329,8 +329,8 @@ class Title {
         * This will only return the very next target, useful for
         * the redirect table and other checks that don't need full recursion
         *
-        * @param $text \type{\string} Text with possible redirect
-        * @return \type{Title} The corresponding Title
+        * @param $text String: Text with possible redirect
+        * @return Title: The corresponding Title
         */
        public static function newFromRedirect( $text ) {
                return self::newFromRedirectInternal( $text );
@@ -595,21 +595,21 @@ class Title {
        /**
         * Get the main part with underscores
         *
-        * @return \type{\string} Main part of the title, with underscores
+        * @return Stromg: Main part of the title, with underscores
         */
        public function getDBkey() { return $this->mDbkeyform; }
 
        /**
         * Get the namespace index, i.e.\ one of the NS_xxxx constants.
         *
-        * @return \type{\int} Namespace index
+        * @return Integer: Namespace index
         */
        public function getNamespace() { return $this->mNamespace; }
 
        /**
         * Get the namespace text
         *
-        * @return \type{\string} Namespace text
+        * @return String: Namespace text
         */
        public function getNsText() {
                global $wgContLang;
@@ -4029,7 +4029,7 @@ class Title {
         * In other words, is this a content page, for the purposes of calculating
         * statistics, etc?
         *
-        * @return \type{\bool}
+        * @return Boolean
         */
        public function isContentPage() {
                return MWNamespace::isContent( $this->getNamespace() );

diff --git a/includes/User.php b/includes/User.php
index f101822..fe95fb1 100644 (file)
--- a/includes/User.php
+++ b/includes/User.php
@@ -2188,7 +2188,7 @@ class User {
        /**
         * Check if user is allowed to access a feature / make an action
         * @param $action \string action to be checked
-        * @return \bool True if action is allowed, else false
+        * @return Boolean: True if action is allowed, else false
         */
        function isAllowed( $action = '' ) {
                if ( $action === '' )
@@ -2206,7 +2206,7 @@ class User {
 
        /**
         * Check whether to enable recent changes patrol features for this user
-        * @return \bool True or false
+        * @return Boolean: True or false
         */
        public function useRCPatrol() {
                global $wgUseRCPatrol;
@@ -2711,7 +2711,7 @@ class User {
 
        /**
         * Get whether the user is blocked from using Special:Emailuser.
-        * @return \bool True if blocked
+        * @return Boolean: True if blocked
         */
        function isBlockedFromEmailuser() {
                $this->getBlockedStatus();
@@ -2720,7 +2720,7 @@ class User {
 
        /**
         * Get whether the user is allowed to create an account.
-        * @return \bool True if allowed
+        * @return Boolean: True if allowed
         */
        function isAllowedToCreateAccount() {
                return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
@@ -2729,7 +2729,7 @@ class User {
        /**
         * Get this user's personal page title.
         *
-        * @return \type{Title} User's personal page title
+        * @return Title: User's personal page title
         */
        function getUserPage() {
                return Title::makeTitle( NS_USER, $this->getName() );
@@ -2738,7 +2738,7 @@ class User {
        /**
         * Get this user's talk page title.
         *
-        * @return \type{Title} User's talk page title
+        * @return Title: User's talk page title
         */
        function getTalkPage() {
                $title = $this->getUserPage();
@@ -2747,7 +2747,7 @@ class User {
 
        /**
         * Get the maximum valid user ID.
-        * @return \int User ID
+        * @return Integer: User ID
         * @static
         */
        function getMaxID() {
@@ -2764,7 +2764,7 @@ class User {
        /**
         * Determine whether the user is a newbie. Newbies are either
         * anonymous IPs, or the most recently created accounts.
-        * @return \bool True if the user is a newbie
+        * @return Boolean: True if the user is a newbie
         */
        function isNewbie() {
                return !$this->isAllowed( 'autoconfirmed' );
@@ -2772,8 +2772,8 @@ class User {
 
        /**
         * Check to see if the given clear-text password is one of the accepted passwords
-        * @param $password \string user password.
-        * @return \bool True if the given password is correct, otherwise False.
+        * @param $password String: user password.
+        * @return Boolean: True if the given password is correct, otherwise False.
         */
        function checkPassword( $password ) {
                global $wgAuth;
@@ -2813,7 +2813,7 @@ class User {
        /**
         * Check if the given clear-text password matches the temporary password
         * sent by e-mail for password reset operations.
-        * @return \bool True if matches, false otherwise
+        * @return Boolean: True if matches, false otherwise
         */
        function checkTemporaryPassword( $plaintext ) {
                global $wgNewPasswordExpiry;
@@ -2871,7 +2871,7 @@ class User {
         *
         * @param $val \string Input value to compare
         * @param $salt \string Optional function-specific data for hashing
-        * @return \bool Whether the token matches
+        * @return Boolean: Whether the token matches
         */
        function matchEditToken( $val, $salt = '' ) {
                $sessionToken = $this->editToken( $salt );
@@ -2887,7 +2887,7 @@ class User {
         *
         * @param $val \string Input value to compare
         * @param $salt \string Optional function-specific data for hashing
-        * @return \bool Whether the token matches
+        * @return Boolean: Whether the token matches
         */
        function matchEditTokenNoSuffix( $val, $salt = '' ) {
                $sessionToken = $this->editToken( $salt );
@@ -3048,7 +3048,7 @@ class User {
        /**
         * Is this user allowed to send e-mails within limits of current
         * site configuration?
-        * @return \bool True if allowed
+        * @return Boolean: True if allowed
         */
        function canSendEmail() {
                global $wgEnableEmail, $wgEnableUserEmail;
@@ -3063,7 +3063,7 @@ class User {
        /**
         * Is this user allowed to receive e-mails within limits of current
         * site configuration?
-        * @return \bool True if allowed
+        * @return Boolean: True if allowed
         */
        function canReceiveEmail() {
                return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
@@ -3077,7 +3077,7 @@ class User {
         * confirmed their address by returning a code or using a password
         * sent to the address from the wiki.
         *
-        * @return \bool True if confirmed
+        * @return Boolean: True if confirmed
         */
        function isEmailConfirmed() {
                global $wgEmailAuthentication;
@@ -3098,7 +3098,7 @@ class User {
 
        /**
         * Check whether there is an outstanding request for e-mail confirmation.
-        * @return \bool True if pending
+        * @return Boolean: True if pending
         */
        function isEmailConfirmationPending() {
                global $wgEmailAuthentication;
@@ -3527,7 +3527,7 @@ class User {
         * @param $hash \string Password hash
         * @param $password \string Plain-text password to compare
         * @param $userId \string User ID for old-style password salt
-        * @return \bool
+        * @return Boolean:
         */
        static function comparePasswords( $hash, $password, $userId = false ) {
                $type = substr( $hash, 0, 3 );

diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php
index 9e670f3..ae5e891 100644 (file)
--- a/includes/parser/Parser.php
+++ b/includes/parser/Parser.php
@@ -1613,7 +1613,7 @@ class Parser {
 
        /**
         * Process [[ ]] wikilinks
-        * @return processed text
+        * @return String: processed text
         *
         * @private
         */