Fixed some doxygen warnings
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 15 May 2010 20:16:26 +0000 (20:16 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Sat, 15 May 2010 20:16:26 +0000 (20:16 +0000)
includes/parser/ParserCache.php
includes/parser/ParserOutput.php

index 524d6be..af59663 100644 (file)
@@ -20,7 +20,7 @@ class ParserCache {
         * Setup a cache pathway with a given back-end storage mechanism.
         * May be a memcached client or a BagOStuff derivative.
         *
-        * @param object $memCached
+        * @param $memCached Object
         */
        function __construct( $memCached ) {
                $this->mMemc = $memCached;
index 9cbcfee..bc805d8 100644 (file)
@@ -101,8 +101,8 @@ class ParserOutput
        /**
         * Record a local or interwiki inline link for saving in future link tables.
         *
-        * @param Title $title
-        * @param mixed $id optional known page_id so we can skip the lookup
+        * @param $title Title object
+        * @param $id Mixed: optional known page_id so we can skip the lookup
         */
        function addLink( $title, $id = null ) {
                if ( $title->isExternal() ) {
@@ -150,7 +150,7 @@ class ParserOutput
        }
        
        /**
-        * @param Title $title object, must be an interwiki link
+        * @param $title Title object, must be an interwiki link
         * @throws MWException if given invalid input
         */
        function addInterwikiLink( $title ) {
@@ -169,11 +169,10 @@ class ParserOutput
         * per-article cache invalidation timestamps, or if it comes from
         * an incompatible older version.
         *
-        * @param string $touched the affected article's last touched timestamp
-        * @return bool
-        * @public
+        * @param $touched String: the affected article's last touched timestamp
+        * @return Boolean
         */
-       function expired( $touched ) {
+       public function expired( $touched ) {
                global $wgCacheEpoch;
                return $this->getCacheTime() == -1 || // parser says it's uncacheable
                       $this->getCacheTime() < $touched ||
@@ -200,7 +199,7 @@ class ParserOutput
         * -- this is assumed to have been validated
         * (check equal normalisation, etc.)
         *
-        * @param string $text Desired title text
+        * @param $text String: desired title text
         */
        public function setDisplayTitle( $text ) {
                $this->setTitleText( $text );
@@ -209,7 +208,7 @@ class ParserOutput
        /**
         * Get the title to be used for display
         *
-        * @return string
+        * @return String
         */
        public function getDisplayTitle() {
                $t = $this->getTitleText( );