From: nicoco007 <nicolas.g@rogers.com>
Date: Mon, 28 Dec 2015 20:35:53 +0000 (-0500)
Subject: Add documentation for wfClientAcceptsGzip()
X-Git-Tag: 1.31.0-rc.0~5027^2
X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=7bd97758f7e1496c7d4a1fa4e7275c9d6c01c5c3;p=lhc%2Fweb%2Fwiklou.git

Add documentation for wfClientAcceptsGzip()

Change-Id: I18b9311d71278ca4c843908a11f77270f03cf534
---

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index e30b3715cf..c4db7e9158 100644
--- 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;