Fix the little documentation that FormOptions::consumeValue() has

Change-Id: I9a4bfaace4f19ba5e3e8a405118fe1bae3a1696d

diff --git a/includes/FormOptions.php b/includes/FormOptions.php
index 1cfe88e..8411bc4 100644 (file)
--- a/includes/FormOptions.php
+++ b/includes/FormOptions.php
@@ -178,8 +178,9 @@ class FormOptions implements ArrayAccess {
 
        /**
         * @todo Document
-        * @param $name String: option name
-        * @return null
+        * @param string $name Option name
+        * @throws MWException If option does not exist.
+        * @return mixed Value or the default value if it is null.
         */
        public function consumeValue( $name ) {
                $this->validateName( $name, true );