Add documentation for wfClientAcceptsGzip()

Change-Id: I18b9311d71278ca4c843908a11f77270f03cf534

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index e30b371..c4db7e9 100644 (file)
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -1983,11 +1983,13 @@ function wfShowingResults( $offset, $limit ) {
 }
 
 /**
 }
 
 /**

- * @todo document
- * @todo FIXME: We may want to blacklist some broken browsers
+ * Whether the client accept gzip encoding

  *
  *

- * @param bool $force
- * @return bool Whereas client accept gzip compression
+ * Uses the Accept-Encoding header to check if the client supports gzip encoding.
+ * Use this when considering to send a gzip-encoded response to the client.
+ *
+ * @param bool $force Forces another check even if we already have a cached result.
+ * @return bool

  */
 function wfClientAcceptsGzip( $force = false ) {
        static $result = null;
  */
 function wfClientAcceptsGzip( $force = false ) {
        static $result = null;