From 2a4c94f90efbb5f6e4737d4cda4a02079c965592 Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Tue, 12 Jul 2011 19:59:35 +0000 Subject: [PATCH] Documentation --- includes/cache/SquidUpdate.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/includes/cache/SquidUpdate.php b/includes/cache/SquidUpdate.php index 2caf269c6d..07ef04acc5 100644 --- a/includes/cache/SquidUpdate.php +++ b/includes/cache/SquidUpdate.php @@ -27,7 +27,7 @@ class SquidUpdate { /** * @param $title Title - * + * * @return SquidUpdate */ static function newFromLinksTo( &$title ) { @@ -85,6 +85,9 @@ class SquidUpdate { return new SquidUpdate( $urlArr ); } + /** + * Purges the list of URLs passed to the constructor + */ function doUpdate() { SquidUpdate::purge( $this->urlArr ); } @@ -111,7 +114,7 @@ class SquidUpdate { } if ( $wgHTCPMulticastAddress && $wgHTCPPort ) { - return SquidUpdate::HTCPPurge( $urlArr ); + SquidUpdate::HTCPPurge( $urlArr ); } wfProfileIn( __METHOD__ ); @@ -139,6 +142,10 @@ class SquidUpdate { wfProfileOut( __METHOD__ ); } + /** + * @throws MWException + * @param $urlArr array + */ static function HTCPPurge( $urlArr ) { global $wgHTCPMulticastAddress, $wgHTCPMulticastTTL, $wgHTCPPort; wfProfileIn( __METHOD__ ); -- 2.20.1