objectcache: Document the primary entry points people should use
authorTimo Tijhof <krinklemail@gmail.com>
Mon, 24 Aug 2015 21:21:56 +0000 (23:21 +0200)
committerTimo Tijhof <krinklemail@gmail.com>
Tue, 25 Aug 2015 01:11:15 +0000 (03:11 +0200)
commit62e3da7e588fef5021035a9facfefb173a4891aa
tree1fd7bf6bf4ab321b935d882cae7630126f3215f5
parentf1223f90fd4b3891bcd18fe621e998c4190c8b9b
objectcache: Document the primary entry points people should use

There are imho too many ObjectCache methods, $wg*Cache* variables,
CACHE_ types, and wfGet*Cache() functions to know which ones
should actually be used publicly. This should make it easier to
know which ones should be used.

The difference between them was also harder to understand with the
main documentation sections about each of these living in
conceptually different places:
- classes (WANObjectCache)
- methods (ObjectCache::getMainStashInstance)
- variables (DefaultSettings: wgMainCacheType, wgMainWANCache, wgMainStash)

Also:
* Correct wfGetCache() documentation.
* Add the missing keywords for 'public' visibility.

Change-Id: I3b05fdb8b7888bf7e3f05bdca36538f3484556b8
includes/GlobalFunctions.php
includes/objectcache/ObjectCache.php