Merge "mw.Upload.BookletLayout: Require non-whitespace description"
[lhc/web/wiklou.git] / includes / Linker.php
index 842d276..5255b9a 100644 (file)
@@ -1393,7 +1393,10 @@ class Linker {
         * is ignored
         *
         * @todo FIXME: Doesn't handle sub-links as in image thumb texts like the main parser
-        * @param string $comment Text to format links in
+        * @param string $comment Text to format links in. WARNING! Since the output of this
+        *      function is html, $comment must be sanitized for use as html. You probably want
+        *      to pass $comment through Sanitizer::escapeHtmlAllowEntities() before calling
+        *      this function.
         * @param Title|null $title An optional title object used to links to sections
         * @param bool $local Whether section links should refer to local page
         * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),