From: Timo Tijhof <krinklemail@gmail.com>
Date: Wed, 20 Jul 2016 16:38:36 +0000 (+0100)
Subject: objectcache: Fix RESTBagOStuff class doc
X-Git-Tag: 1.31.0-rc.0~6309^2
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dmembres/cotisations/gestion/rappel_supprimer.php?a=commitdiff_plain;h=272c14db8fe7aa5d6de31220de8ecd6be8995a5a;p=lhc%2Fweb%2Fwiklou.git

objectcache: Fix RESTBagOStuff class doc

Currently renders slightly broken since a single line break
is ignored in Markdown (Doxygen parses these as Markdown).

Change-Id: Ibdff93e103f98b7bd8d3ef9118f246fedab288cf
---

diff --git a/includes/libs/objectcache/RESTBagOStuff.php b/includes/libs/objectcache/RESTBagOStuff.php
index 1bbfc56c19..9fc3fe1dc8 100644
--- a/includes/libs/objectcache/RESTBagOStuff.php
+++ b/includes/libs/objectcache/RESTBagOStuff.php
@@ -1,16 +1,24 @@
 <?php
 
 /**
- * Interface to key-value storage on HTTP RESTful server, such as RESTBase.
- * Uses URL of the form URL/{KEY} to store/fetch/delete.
- * E.g., when base URL is /v1/sessions/ then the store would do:
- * PUT /v1/sessions/12345758
+ * Interface to key-value storage behind an HTTP server.
+ *
+ * Uses URL of the form "baseURL/{KEY}" to store, fetch, and delete values.
+ *
+ * E.g., when base URL is `/v1/sessions/`, then the store would do:
+ *
+ * `PUT /v1/sessions/12345758`
+ *
  * and fetch would do:
- * GET /v1/sessions/12345758
+ *
+ * `GET /v1/sessions/12345758`
+ *
  * delete would do:
- * DELETE /v1/sessions/12345758
+ *
+ * `DELETE /v1/sessions/12345758`
  *
  * Configure with:
+ *
  * @code
  * $wgObjectCaches['sessions'] = array(
  *	'class' => 'RESTBagOStuff',