r105830 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r105829‎ | r105830 | r105831 >
Date:20:57, 11 December 2011
Author:reedy
Status:ok
Tags:
Comment:
More documentation updates as I've been going around
Modified paths:
  • /trunk/phase3/includes/api/ApiPageSet.php (modified) (history)
  • /trunk/phase3/includes/api/ApiQueryAllCategories.php (modified) (history)
  • /trunk/phase3/includes/specials/SpecialExport.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiQueryAllCategories.php
@@ -50,7 +50,6 @@
5151
5252 /**
5353 * @param $resultPageSet ApiPageSet
54 - * @return void
5554 */
5655 private function run( $resultPageSet = null ) {
5756 $db = $this->getDB();
Index: trunk/phase3/includes/api/ApiPageSet.php
@@ -52,7 +52,7 @@
5353
5454 /**
5555 * Constructor
56 - * @param $query ApiQuery
 56+ * @param $query ApiQueryBase
5757 * @param $resolveRedirects bool Whether redirects should be resolved
5858 * @param $convertTitles bool
5959 */
Index: trunk/phase3/includes/specials/SpecialExport.php
@@ -231,6 +231,9 @@
232232 $out->addHTML( $form );
233233 }
234234
 235+ /**
 236+ * @return bool
 237+ */
235238 private function userCanOverrideExportDepth() {
236239 return $this->getUser()->isAllowed( 'override-export-depth' );
237240 }
@@ -337,6 +340,10 @@
338341 }
339342 }
340343
 344+ /**
 345+ * @param $title Title
 346+ * @return array
 347+ */
341348 private function getPagesFromCategory( $title ) {
342349 global $wgContLang;
343350
@@ -365,6 +372,10 @@
366373 return $pages;
367374 }
368375
 376+ /**
 377+ * @param $nsindex int
 378+ * @return array
 379+ */
369380 private function getPagesFromNamespace( $nsindex ) {
370381 global $wgContLang;
371382
@@ -408,6 +419,8 @@
409420
410421 /**
411422 * Validate link depth setting, if available.
 423+ * @param $depth int
 424+ * @return int
412425 */
413426 private function validateLinkDepth( $depth ) {
414427 global $wgExportMaxLinkDepth;
@@ -430,7 +443,13 @@
431444 return intval( min( $depth, 5 ) );
432445 }
433446
434 - /** Expand a list of pages to include pages linked to from that page. */
 447+ /**
 448+ * Expand a list of pages to include pages linked to from that page.
 449+ * @param $inputPages array
 450+ * @param $pageSet array
 451+ * @param $depth int
 452+ * @return array
 453+ */
435454 private function getPageLinks( $inputPages, $pageSet, $depth ) {
436455 for( ; $depth > 0; --$depth ) {
437456 $pageSet = $this->getLinks(

Status & tagging log