Document that setSubtitle() and addSubtitle() need safe HTML

Change-Id: Id5431fc20fb9e9cc755e6a3c393146888a5b666e

diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index 2c32c6a..b69069b 100644 (file)
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -851,11 +851,10 @@ class OutputPage extends ContextSource {
                $this->getContext()->setTitle( $t );
        }
 
-
        /**
         * Replace the subtile with $str
         *
-        * @param $str String|Message: new value of the subtitle
+        * @param $str String|Message: new value of the subtitle. String should be safe HTML.
         */
        public function setSubtitle( $str ) {
                $this->clearSubtitle();
@@ -875,7 +874,7 @@ class OutputPage extends ContextSource {
        /**
         * Add $str to the subtitle
         *
-        * @param $str String|Message to add to the subtitle
+        * @param $str String|Message to add to the subtitle. String should be safe HTML.
         */
        public function addSubtitle( $str ) {
                if ( $str instanceof Message ) {