doc: Fix a few Example docs for PHP classes
authorTimo Tijhof <krinklemail@gmail.com>
Tue, 18 Jul 2017 01:24:32 +0000 (20:24 -0500)
committerTimo Tijhof <krinklemail@gmail.com>
Tue, 18 Jul 2017 01:29:58 +0000 (20:29 -0500)
commitc689fd2e4cc14bedeaa4303aa9958f95d96a2779
tree4066b639d76cb3a3ffdbe641e242c6382dfae1ea
parent9c6f6681afd55b96de751fdfcf8fd0acd43c4c03
doc: Fix a few Example docs for PHP classes

* "@example" is specifically for creating entries on the "Examples"
  page produced by Doxygen, which is not specific to individual classes
  or methods, but rather is meant to be about the software as a whole.
  There are currently four entries produced there, and they are all broken:
  - .../src/includes/rcfeed/RedisPubSubFeedEngine.php (unnamed example, broken)
  - .../src/tests/phpunit/MediaWikiTestCase.php (unnamed example)
  - 42 (empty page named "42")
  - user (empty page named "user")

* Remove usage and replace with either a regular paragraph that is
  part of the member/method/class description, or for code examples,
  use "@par" to create a sub heading, and then a @code-@endcode block.

Change-Id: I52c937fef4b377173f6c4dbad9dc4a9f8beae4ee
includes/XmlJsCode.php
includes/libs/MemoizedCallable.php
includes/rcfeed/RedisPubSubFeedEngine.php
includes/specials/SpecialRedirect.php
tests/phpunit/MediaWikiTestCase.php