From: Sam Reed <reedy@users.mediawiki.org>
Date: Sun, 11 Dec 2011 20:57:57 +0000 (+0000)
Subject: More documentation updates as I've been going around
X-Git-Tag: 1.31.0-rc.0~26069
X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=35e229c627b6c7d97bf23132db1500cefeca5edb;p=lhc%2Fweb%2Fwiklou.git

More documentation updates as I've been going around
---

diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php
index 7be439f996..7b84c473dd 100644
--- 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 0a95594dec..78367a45cd 100644
--- 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 4e2d00e547..ae7d865393 100644
--- 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(