Linker: Document parseComment() as returning HTML

It's not entirely clear from the documentation whether this method
returns wikitext or HTML, so make it explicit.

Change-Id: I094e370e921c43dd8c5dc4376b3dddd803665d90

diff --git a/includes/Linker.php b/includes/Linker.php
index da8daf4..a3fba83 100644 (file)
--- a/includes/Linker.php
+++ b/includes/Linker.php
@@ -1083,7 +1083,7 @@ class Linker {
         * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
         *  For use with external changes.
         *
-        * @return mixed|string
+        * @return string HTML
         */
        public static function formatComment(
                $comment, $title = null, $local = false, $wikiId = null