From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Sun, 16 Dec 2012 21:14:01 +0000 (+0100)
Subject: Fix the little documentation that FormOptions::consumeValue() has
X-Git-Tag: 1.31.0-rc.0~21277
X-Git-Url: http://git.cyclocoop.org/clavettes/images/siteon3.jpg?a=commitdiff_plain;h=7e0d8d597de64602b520c83ed8c9bdfaeea75c2e;p=lhc%2Fweb%2Fwiklou.git

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

Change-Id: I9a4bfaace4f19ba5e3e8a405118fe1bae3a1696d
---

diff --git a/includes/FormOptions.php b/includes/FormOptions.php
index 1cfe88e891..8411bc48ae 100644
--- 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 );