From: Roan Kattouw <roan.kattouw@gmail.com>
Date: Fri, 12 Oct 2018 22:18:03 +0000 (-0700)
Subject: Linker: Document parseComment() as returning HTML
X-Git-Tag: 1.34.0-rc.0~3783^2
X-Git-Url: http://git.cyclocoop.org/%22%2C%20generer_url_ecrire%28?a=commitdiff_plain;h=39e2e85a4462739c10724c71ff49f4780b4416d9;p=lhc%2Fweb%2Fwiklou.git

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 da8daf4c8b..a3fba831d4 100644
--- 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