HtmlArmor: Document that null is an acceptable value

And that you'll get null back.

Change-Id: Ibd74e6af16b51796b46c2e23b7442740f5f69a0f

diff --git a/includes/libs/HtmlArmor.php b/includes/libs/HtmlArmor.php
index 4ba1bc3..1c141ab 100644 (file)
--- a/includes/libs/HtmlArmor.php
+++ b/includes/libs/HtmlArmor.php
@@ -28,12 +28,12 @@
 class HtmlArmor {
 
        /**
-        * @var string
+        * @var string|null
         */
        private $value;
 
        /**
-        * @param string $value
+        * @param string|null $value
         */
        public function __construct( $value ) {
                $this->value = $value;
@@ -44,7 +44,8 @@ class HtmlArmor {
         * and get safe HTML back
         *
         * @param string|HtmlArmor $input
-        * @return string safe for usage in HTML
+        * @return string|null safe for usage in HTML, or null
+        *         if the HtmlArmor instance was wrapping null.
         */
        public static function getHtml( $input ) {
                if ( $input instanceof HtmlArmor ) {