From 23b159027806d840556e6a9a19a5eb6d47aa98d9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Sun, 13 Oct 2013 13:58:52 +0000 Subject: [PATCH] FormOptions: Document getValueReal(), consistency fixes I missed it in my previous doco commit, good opportunity to try out the fancy new tool. Change-Id: I52005b243042c3d66250d1cfecfceabbd370ea5c --- includes/FormOptions.php | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/includes/FormOptions.php b/includes/FormOptions.php index eff175649c..54822e3271 100644 --- a/includes/FormOptions.php +++ b/includes/FormOptions.php @@ -144,10 +144,10 @@ class FormOptions implements ArrayAccess { /** * Use to set the value of an option. * - * @param string $name option name - * @param mixed $value value for the option - * @param bool $force Whether to set the value when it is equivalent to - * the default value for this option (default false). + * @param string $name Option name + * @param mixed $value Value for the option + * @param bool $force Whether to set the value when it is equivalent to the default value for this + * option (default false). */ public function setValue( $name, $value, $force = false ) { $this->validateName( $name, true ); @@ -161,10 +161,9 @@ class FormOptions implements ArrayAccess { } /** - * Get the value for the given option name. - * Internally use getValueReal() + * Get the value for the given option name. Uses getValueReal() internally. * - * @param string $name option name + * @param string $name Option name * @return mixed */ public function getValue( $name ) { @@ -174,9 +173,10 @@ class FormOptions implements ArrayAccess { } /** - * @todo Document - * @param array $option array structure describing the option - * @return mixed Value or the default value if it is null + * Return current option value, based on a structure taken from $options. + * + * @param array $option Array structure describing the option + * @return mixed Value, or the default value if it is null */ protected function getValueReal( $option ) { if ( $option['value'] !== null ) { -- 2.20.1