Document expected input and return value for Language::convert()

Bug: T202571
Change-Id: I1598f8a83d9cb2ab9d9e9ba96acd90f70edd59ad

diff --git a/languages/Language.php b/languages/Language.php
index eab09a1..cbdd59d 100644 (file)
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -4194,8 +4194,8 @@ class Language {
        /**
         * convert text to different variants of a language.
         *
-        * @param string $text
-        * @return string
+        * @param string $text Content that has been already escaped for use in HTML
+        * @return string HTML
         */
        public function convert( $text ) {
                return $this->mConverter->convert( $text );