SquidUpdate doc cleanups
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 19 Nov 2015 00:07:29 +0000 (16:07 -0800)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 19 Nov 2015 00:07:29 +0000 (16:07 -0800)
Change-Id: Ia5b8060e8a93f40a2e31272e043b225f59fb6d50

includes/deferred/SquidUpdate.php

index bad91a5..d33e4a5 100644 (file)
@@ -30,7 +30,7 @@ class SquidUpdate implements DeferrableUpdate {
        protected $urls = array();
 
        /**
-        * @param array $urlArr Collection of URLs to purge
+        * @param string[] $urlArr Collection of URLs to purge
         */
        public function __construct( array $urlArr ) {
                // Remove duplicate URLs from list
@@ -41,7 +41,7 @@ class SquidUpdate implements DeferrableUpdate {
         * Create a SquidUpdate from an array of Title objects, or a TitleArray object
         *
         * @param Traversable|array $titles
-        * @param array $urlArr
+        * @param string[] $urlArr
         * @return SquidUpdate
         */
        public static function newFromTitles( $titles, $urlArr = array() ) {
@@ -77,7 +77,7 @@ class SquidUpdate implements DeferrableUpdate {
         * (example: $urlArr[] = 'http://my.host/something')
         * XXX report broken Squids per mail or log
         *
-        * @param array $urlArr List of full URLs to purge
+        * @param string[] $urlArr List of full URLs to purge
         */
        public static function purge( array $urlArr ) {
                global $wgSquidServers, $wgHTCPRouting;
@@ -125,9 +125,9 @@ class SquidUpdate implements DeferrableUpdate {
         * Send Hyper Text Caching Protocol (HTCP) CLR requests.
         *
         * @throws MWException
-        * @param array $urlArr Collection of URLs to purge
+        * @param string[] $urlArr Collection of URLs to purge
         */
-       protected static function HTCPPurge( $urlArr ) {
+       protected static function HTCPPurge( array $urlArr ) {
                global $wgHTCPRouting, $wgHTCPMulticastTTL;
 
                // HTCP CLR operation