Fix documentation in Linker::formatTemplates.
authorTyler Anthony Romeo <tylerromeo@gmail.com>
Tue, 15 Jan 2013 20:35:41 +0000 (15:35 -0500)
committerTyler Anthony Romeo <tylerromeo@gmail.com>
Wed, 23 Jan 2013 05:43:53 +0000 (00:43 -0500)
Follow up to 265404d93cd99bf067064f947f5fc361f54466d7.
Make it clear that when a string is passed to the function,
it has to be already escaped. Also added Message as a
possible parameter type.

Change-Id: I4fb309d0dfcdf61b92c42db4b7ca2ea651d5f071

includes/Linker.php

index 2f6ee22..ce82274 100644 (file)
@@ -1927,13 +1927,13 @@ class Linker {
         * Make an HTML list of templates, and then add a "More..." link at
         * the bottom. If $more is null, do not add a "More..." link. If $more
         * is a Title, make a link to that title and use it. If $more is a string,
-        * directly paste it in as the link.
+        * directly paste it in as the link (escaping needs to be done manually).
+        * Finally, if $more is a Message, call toString().
         *
-        * @param $templates Array of templates from Article::getUsedTemplate
-        * or similar
+        * @param array $templates Array of templates from Article::getUsedTemplate or similar
         * @param bool $preview Whether this is for a preview
         * @param bool $section Whether this is for a section edit
-        * @param Title|string|null $more A link for "More..." of the templates
+        * @param Title|Message|string|null $more An escaped link for "More..." of the templates
         * @return String: HTML output
         */
        public static function formatTemplates( $templates, $preview = false, $section = false, $more = null ) {