More documentation updates as I've been going around

diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php
index 7be439f..7b84c47 100644 (file)
--- a/includes/api/ApiPageSet.php
+++ b/includes/api/ApiPageSet.php
@@ -52,7 +52,7 @@ class ApiPageSet extends ApiQueryBase {
 
        /**
         * Constructor
-        * @param $query ApiQuery
+        * @param $query ApiQueryBase
         * @param $resolveRedirects bool Whether redirects should be resolved
         * @param $convertTitles bool
         */

diff --git a/includes/api/ApiQueryAllCategories.php b/includes/api/ApiQueryAllCategories.php
index 0a95594..78367a4 100644 (file)
--- a/includes/api/ApiQueryAllCategories.php
+++ b/includes/api/ApiQueryAllCategories.php
@@ -50,7 +50,6 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
 
        /**
         * @param $resultPageSet ApiPageSet
-        * @return void
         */
        private function run( $resultPageSet = null ) {
                $db = $this->getDB();

diff --git a/includes/specials/SpecialExport.php b/includes/specials/SpecialExport.php
index 4e2d00e..ae7d865 100644 (file)
--- a/includes/specials/SpecialExport.php
+++ b/includes/specials/SpecialExport.php
@@ -231,6 +231,9 @@ class SpecialExport extends SpecialPage {
                $out->addHTML( $form );
        }
 
+       /**
+        * @return bool
+        */
        private function userCanOverrideExportDepth() {
                return $this->getUser()->isAllowed( 'override-export-depth' );
        }
@@ -337,6 +340,10 @@ class SpecialExport extends SpecialPage {
                }
        }
 
+       /**
+        * @param $title Title
+        * @return array
+        */
        private function getPagesFromCategory( $title ) {
                global $wgContLang;
 
@@ -365,6 +372,10 @@ class SpecialExport extends SpecialPage {
                return $pages;
        }
 
+       /**
+        * @param $nsindex int
+        * @return array
+        */
        private function getPagesFromNamespace( $nsindex ) {
                global $wgContLang;
 
@@ -408,6 +419,8 @@ class SpecialExport extends SpecialPage {
 
        /**
         * Validate link depth setting, if available.
+        * @param $depth int
+        * @return int
         */
        private function validateLinkDepth( $depth ) {
                global $wgExportMaxLinkDepth;
@@ -430,7 +443,13 @@ class SpecialExport extends SpecialPage {
                return intval( min( $depth, 5 ) );
        }
 
-       /** Expand a list of pages to include pages linked to from that page. */
+       /**
+        * Expand a list of pages to include pages linked to from that page.
+        * @param $inputPages array
+        * @param $pageSet array
+        * @param $depth int
+        * @return array
+        */
        private function getPageLinks( $inputPages, $pageSet, $depth ) {
                for( ; $depth > 0; --$depth ) {
                        $pageSet = $this->getLinks(