And even more documentation in various files
authorSam Reed <reedy@users.mediawiki.org>
Sun, 29 May 2011 14:25:20 +0000 (14:25 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sun, 29 May 2011 14:25:20 +0000 (14:25 +0000)
includes/Revision.php
includes/ZhClient.php
includes/objectcache/ObjectCache.php
includes/parser/CoreTagHooks.php
includes/parser/LinkHolderArray.php
includes/search/SearchMySQL.php
includes/search/SearchSqlite.php
includes/specials/SpecialRecentchanges.php
includes/specials/SpecialStatistics.php
includes/upload/UploadFromStash.php
includes/upload/UploadStash.php

index 66501d2..0780f74 100644 (file)
@@ -67,6 +67,9 @@ class Revision {
         * for permissions or even inserted (as in Special:Undelete)
         * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
         *
+        * @param $row
+        * @param $overrides array
+        *
         * @return Revision
         */
        public static function newFromArchiveRow( $row, $overrides = array() ) {
index 7807319..8bb36b2 100644 (file)
@@ -9,7 +9,10 @@ class ZhClient {
        /**
         * Constructor
         *
-        * @access private
+        * @param $host
+        * @param $port
+        *
+        * @return ZhClient
         */
        function __construct( $host, $port ) {
                $this->mHost = $host;
@@ -48,6 +51,8 @@ class ZhClient {
         * Query the daemon and return the result
         *
         * @access private
+        *
+        * @return string
         */
        function query( $request ) {
                if ( !$this->mConnected ) {
index a798203..eebff32 100644 (file)
@@ -34,6 +34,10 @@ class ObjectCache {
 
        /**
         * Create a new cache object of the specified type.
+        *
+        * @param $id
+        *
+        * @return ObjectCache
         */
        static function newFromId( $id ) {
                global $wgObjectCaches;
@@ -50,6 +54,8 @@ class ObjectCache {
         * Create a new cache object from parameters
         *
         * @param $params array
+        *
+        * @return ObjectCache
         */
        static function newFromParams( $params ) {
                if ( isset( $params['factory'] ) ) {
index 458088f..7d488c4 100644 (file)
@@ -54,7 +54,7 @@ class CoreTagHooks {
         * Uses undocumented extended tag hook return values, introduced in r61913.
         *
         * @param $content string
-        * @param $attribs array
+        * @param $attributes array
         * @param $parser Parser
         * @return array
         */
@@ -75,7 +75,7 @@ class CoreTagHooks {
         * Uses undocumented extended tag hook return values, introduced in r61913.
         *
         * @param $content string
-        * @param  $attribs array
+        * @param $attributes array
         * @param $parser Parser
         * @return array
         */
index 835deb8..5418b6e 100644 (file)
@@ -94,7 +94,7 @@ class LinkHolderArray {
         * strings will be returned.
         *
         * @param $other LinkHolderArray
-        * @param $text Array of strings
+        * @param $texts Array of strings
         * @return Array
         */
        function mergeForeign( $other, $texts ) {
index 51c73b6..a2c27ba 100644 (file)
@@ -44,6 +44,9 @@ class SearchMySQL extends SearchEngine {
         * Parse the user's query and transform it into an SQL fragment which will 
         * become part of a WHERE clause
         *
+        * @param $filteredText string
+        * @param $fullText string
+        *
         * @return string
         */
        function parseQuery( $filteredText, $fulltext ) {
index d58b7b9..cd59eea 100644 (file)
@@ -51,6 +51,8 @@ class SearchSqlite extends SearchEngine {
        /**
         * Parse the user's query and transform it into an SQL fragment which will
         * become part of a WHERE clause
+        *
+        * @return string
         */
        function parseQuery( $filteredText, $fulltext ) {
                global $wgContLang;
@@ -72,7 +74,9 @@ class SearchSqlite extends SearchEngine {
                                        $quote = '"';
                                }
 
-                               if( $searchon !== '' ) $searchon .= ' ';
+                               if( $searchon !== '' ) {
+                                       $searchon .= ' ';
+                               }
 
                                // Some languages such as Serbian store the input form in the search index,
                                // so we may need to search for matches in multiple writing system variants.
index e67b1e4..479a78a 100644 (file)
@@ -66,6 +66,8 @@ class SpecialRecentChanges extends IncludableSpecialPage {
        /**
         * Create a FormOptions object with options as specified by the user
         *
+        * @param $parameters array
+        *
         * @return FormOptions
         */
        public function setup( $parameters ) {
index c9290f6..fd23968 100644 (file)
@@ -124,8 +124,7 @@ class SpecialStatistics extends SpecialPage {
                                        " ($descriptionText)" );
                        }
                }
-               return
-               Html::rawElement( 'tr', $trExtraParams,
+               return Html::rawElement( 'tr', $trExtraParams,
                        Html::rawElement( 'td', array(), $text ) .
                        Html::rawElement( 'td', array( 'class' => 'mw-statistics-numbers' ), $number )
                );
index 2ceea0d..7077bcb 100644 (file)
@@ -73,6 +73,8 @@ class UploadFromStash extends UploadBase {
 
        /**
         * File has been previously verified so no need to do so again.
+        *
+        * @return bool
         */
        protected function verifyFile() {
                return true;
index 7a3c01b..2412643 100644 (file)
@@ -34,6 +34,8 @@ class UploadStash {
        /**
         * Represents the session which contains temporarily stored files.
         * Designed to be compatible with the session stashing code in UploadBase (should replace it eventually)
+        *
+        * @param $repo FileRepo
         */
        public function __construct( $repo ) {