Francois Gouget : testbot/cgi: Improve the CollectionBlock::GetDetailsLink() documentation.

[Alexandre Julliard]

Module: tools
Branch: master
Commit: 66e2dde97105abd31f2e84cfe90b174986b7aded
URL:    https://source.winehq.org/git/tools.git/?a=commit;h=66e2dde97105abd31f2e84cf...

Author: Francois Gouget 
Date:   Tue May  3 19:38:21 2022 +0200

testbot/cgi: Improve the CollectionBlock::GetDetailsLink() documentation.

Specifically, better document the escaping situation.

Signed-off-by: Francois Gouget 
Signed-off-by: Alexandre Julliard

---

testbot/lib/ObjectModel/CGI/CollectionBlock.pm | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/testbot/lib/ObjectModel/CGI/CollectionBlock.pm b/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
index b2ebb2e..594ed56 100644
--- a/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
+++ b/testbot/lib/ObjectModel/CGI/CollectionBlock.pm
@@ -200,6 +200,10 @@ sub GetSortedItems($$)

Returns the URL of the details page for the current row's object.

+If the URL contains parameters those must already be encoded (see uri_escape())
+but the returned URL as a whole may still need to be escaped for use in HTML
+documents (notably for the ampersands, see escapeHTML()).
+
 See GenerateDataView() for details about the Row parameter.

=back