Fix some method documentation
authorSam Reed <reedy@users.mediawiki.org>
Wed, 20 Oct 2010 18:50:33 +0000 (18:50 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Wed, 20 Oct 2010 18:50:33 +0000 (18:50 +0000)
Fix some typos

Some explicit class members

includes/Title.php
includes/api/ApiDelete.php
includes/api/ApiPageSet.php
includes/api/ApiParse.php
includes/api/ApiQuery.php
includes/api/ApiQueryRecentChanges.php
includes/api/ApiQueryRevisions.php
includes/api/ApiQueryUserContributions.php

index 5e136fc..4db46f2 100644 (file)
@@ -2740,7 +2740,7 @@ class Title {
        /**
         * Get a Title object associated with the talk page of this article
         *
-        * @return \type{Title} the object for the talk page
+        * @return Title the object for the talk page
         */
        public function getTalkPage() {
                return Title::makeTitle( MWNamespace::getTalk( $this->getNamespace() ), $this->getDBkey() );
@@ -2750,7 +2750,7 @@ class Title {
         * Get a title object associated with the subject page of this
         * talk page
         *
-        * @return \type{Title} the object for the subject page
+        * @return Title the object for the subject page
         */
        public function getSubjectPage() {
                // Is this the same title?
index 8202c60..aefd7b3 100644 (file)
@@ -30,7 +30,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 }
 
 /**
- * API module that facilitates deleting pages. The API eqivalent of action=delete.
+ * API module that facilitates deleting pages. The API equivalent of action=delete.
  * Requires API write mode to be enabled.
  *
  * @ingroup API
index 2eafbb3..f54f1f8 100644 (file)
@@ -347,7 +347,7 @@ class ApiPageSet extends ApiQueryBase {
        /**
         * Populate this PageSet from a rowset returned from the database
         * @param $db Database object
-        * @param $queryResult Query result object
+        * @param $queryResult ResultWrapper Query result object
         */
        public function populateFromQueryResult( $db, $queryResult ) {
                $this->profileIn();
@@ -468,7 +468,7 @@ class ApiPageSet extends ApiQueryBase {
         * Iterate through the result of the query on 'page' table,
         * and for each row create and store title object and save any extra fields requested.
         * @param $db Database
-        * @param $res DB Query result
+        * @param $res ResultWrapper DB Query result
         * @param $remaining array of either pageID or ns/title elements (optional).
         *        If given, any missing items will go to $mMissingPageIDs and $mMissingTitles
         * @param $processTitles bool Must be provided together with $remaining.
index f5e520a..c487ca8 100644 (file)
@@ -34,6 +34,8 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiParse extends ApiBase {
 
+       private $section;
+
        public function __construct( $main, $action ) {
                parent::__construct( $main, $action );
        }
index 6027818..31ce8a9 100644 (file)
@@ -301,9 +301,9 @@ class ApiQuery extends ApiBase {
 
        /**
         * Create instances of all modules requested by the client
-        * @param $modules array to append instatiated modules to
+        * @param $modules Array to append instantiated modules to
         * @param $param string Parameter name to read modules from
-        * @param $moduleList array(modulename => classname)
+        * @param $moduleList Array array(modulename => classname)
         */
        private function instantiateModules( &$modules, $param, $moduleList ) {
                $list = @$this->params[$param];
@@ -576,15 +576,15 @@ class ApiQuery extends ApiBase {
                $this->mPageSet = null;
                $this->mAllowedGenerators = array(); // Will be repopulated
 
-               $astriks = str_repeat( '--- ', 8 );
-               $astriks2 = str_repeat( '*** ', 10 );
-               $msg .= "\n$astriks Query: Prop  $astriks\n\n";
+               $asterisk = str_repeat( '--- ', 8 );
+               $asterisk2 = str_repeat( '*** ', 10 );
+               $msg .= "\n$asterisk Query: Prop  $asterisk\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryPropModules, 'prop' );
-               $msg .= "\n$astriks Query: List  $astriks\n\n";
+               $msg .= "\n$asterisk Query: List  $asterisk\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryListModules, 'list' );
-               $msg .= "\n$astriks Query: Meta  $astriks\n\n";
+               $msg .= "\n$asterisk Query: Meta  $asterisk\n\n";
                $msg .= $this->makeHelpMsgHelper( $this->mQueryMetaModules, 'meta' );
-               $msg .= "\n\n$astriks2 Modules: continuation  $astriks2\n\n";
+               $msg .= "\n\n$asterisk2 Modules: continuation  $asterisk2\n\n";
 
                // Perform the base call last because the $this->mAllowedGenerators
                // will be updated inside makeHelpMsgHelper()
@@ -596,7 +596,7 @@ class ApiQuery extends ApiBase {
 
        /**
         * For all modules in $moduleList, generate help messages and join them together
-        * @param $moduleList array(modulename => classname)
+        * @param $moduleList Array array(modulename => classname)
         * @param $paramName string Parameter name
         * @return string
         */
index 0281a04..32d1bf8 100644 (file)
@@ -91,7 +91,7 @@ class ApiQueryRecentChanges extends ApiQueryBase {
 
        /**
         * Sets internal state to include the desired properties in the output.
-        * @param $prop associative array of properties, only keys are used here
+        * @param $prop Array associative array of properties, only keys are used here
         */
        public function initProperties( $prop ) {
                $this->fld_comment = isset( $prop['comment'] );
index c495d3b..355db5b 100644 (file)
@@ -46,6 +46,8 @@ class ApiQueryRevisions extends ApiQueryBase {
                        $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
                        $fld_content = false, $fld_tags = false;
 
+       private $tokenFunctions;
+
        protected function getTokenFunctions() {
                // tokenname => function
                // function prototype is func($pageid, $title, $rev)
index e164683..3be3023 100644 (file)
@@ -40,7 +40,7 @@ class ApiQueryContributions extends ApiQueryBase {
                parent::__construct( $query, $moduleName, 'uc' );
        }
 
-       private $params, $prefixMode, $userprefix, $multiUserMode;
+       private $params, $prefixMode, $userprefix, $multiUserMode, $usernames;
        private $fld_ids = false, $fld_title = false, $fld_timestamp = false,
                        $fld_comment = false, $fld_parsedcomment = false, $fld_flags = false,
                        $fld_patrolled = false, $fld_tags = false, $fld_size = false;