Improve OutputPage::wrapWikiMsg documentation
authorGergő Tisza <tgr.huwiki@gmail.com>
Mon, 7 Jan 2019 01:33:50 +0000 (17:33 -0800)
committerGergő Tisza <tgr.huwiki@gmail.com>
Mon, 7 Jan 2019 01:33:50 +0000 (17:33 -0800)
Four spaces before the code sample makes it actually intepreted as
code sample in many phpdoc parsers (e.g. PhpStorm) instead of trying
to intepret HTML tags as HTML and making a mess of things.

Change-Id: I17d09a64116fa9b1372a7fd39f2a8049dcf805b1

includes/OutputPage.php

index 02e13e7..61a1ef2 100644 (file)
@@ -4134,12 +4134,12 @@ class OutputPage extends ContextSource {
         *
         * For example:
         *
-        *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
+        *     $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
         *
         * Is equivalent to:
         *
-        *    $wgOut->addWikiTextAsInterface( "<div class='error'>\n"
-        *        . wfMessage( 'some-error' )->plain() . "\n</div>" );
+        *     $wgOut->addWikiTextAsInterface( "<div class='error'>\n"
+        *         . wfMessage( 'some-error' )->plain() . "\n</div>" );
         *
         * The newline after the opening div is needed in some wikitext. See T21226.
         *