From: Marius Hoch <hoo@online.de>
Date: Fri, 26 Aug 2016 01:58:59 +0000 (+0200)
Subject: Fix docs for the HtmlPageLinkRenderer hooks
X-Git-Tag: 1.31.0-rc.0~5873^2
X-Git-Url: http://git.cyclocoop.org/ecrire?a=commitdiff_plain;h=4858ae0ce1cd142048b6dda62e5b5757446c43d7;p=lhc%2Fweb%2Fwiklou.git

Fix docs for the HtmlPageLinkRenderer hooks

The $text parameter wasn't correctly documented here,
as far as I can tell.

Change-Id: I335d1a59739d80f9f904872e3135f0aae7535956
---

diff --git a/docs/hooks.txt b/docs/hooks.txt
index a0ee8bde3a..7f1640b48f 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -1937,8 +1937,8 @@ LinkRenderer, before processing starts.  Return false to skip default
 processing and return $ret.
 $linkRenderer: the LinkRenderer object
 $target: the LinkTarget that the link is pointing to
-&$html: the contents that the <a> tag should have (raw HTML); null means
-  "default".
+&$text: the contents that the <a> tag should have; either a plain, unescaped
+  string or a HtmlArmor object; null means "default".
 &$customAttribs: the HTML attributes that the <a> tag should have, in
   associative array form, with keys and values unescaped.  Should be merged
   with default values, with a value of false meaning to suppress the
@@ -1955,7 +1955,8 @@ return false, $ret will be returned.
 $linkRenderer: the LinkRenderer object
 $target: the LinkTarget object that the link is pointing to
 $isKnown: boolean indicating whether the page is known or not
-&$html: the final (raw HTML) contents of the <a> tag, after processing.
+&$text: the contents that the <a> tag should have; either a plain, unescaped
+  string or a HtmlArmor object.
 &$attribs: the final HTML attributes of the <a> tag, after processing, in
   associative array form.
 &$ret: the value to return if your hook returns false.