StringUtils: Fixup Doxygen warnings
authorTimo Tijhof <krinklemail@gmail.com>
Mon, 23 Nov 2015 21:11:21 +0000 (21:11 +0000)
committerTimo Tijhof <krinklemail@gmail.com>
Mon, 23 Nov 2015 21:11:21 +0000 (21:11 +0000)
commit95d5448ad5c6250cadbfc0f2913cc63ce8618c32
tree86f045d8091056aabdb12f7abeae7dcd6ca900af
parentff39e4022dc11244df40b4f96088d5c11a89fa70
StringUtils: Fixup Doxygen warnings

* Code blocks must be indented by 4 spaces (so 5 in total from the star).

* Code blocks are only supported in descriptions, and for some reason the first
  line is separate from the description, so there must be an additional line of
  text between the summary and the code block since it can't be the first thing
  in a description.

* Fix regex confusion with comment syntax due to "/*\/".

To verify these findings, use:

    $ php maintenance/mwdocgen.php --file includes/libs/StringUtils.php

And check the output warnings and generated html pages.

Change-Id: I259b87c0bf3b48a95df0108eb6ee799c25b2853f
includes/libs/StringUtils.php