jenkins-bot has submitted this change and it was merged.
Change subject: FormOptions: Document getValueReal(), consistency fixes
......................................................................
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
---
M includes/FormOptions.php
1 file changed, 10 insertions(+), 10 deletions(-)
Approvals:
Alex Monk: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/FormOptions.php b/includes/FormOptions.php
index eff1756..54822e3 100644
--- a/includes/FormOptions.php
+++ b/includes/FormOptions.php
@@ -144,10 +144,10 @@
/**
* 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 @@
}
/**
- * 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 @@
}
/**
- * @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 ) {
--
To view, visit https://gerrit.wikimedia.org/r/89514
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I52005b243042c3d66250d1cfecfceabbd370ea5c
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Gerrit Patch Uploader <[email protected]>
Gerrit-Reviewer: Alex Monk <[email protected]>
Gerrit-Reviewer: Bartosz Dziewoński <[email protected]>
Gerrit-Reviewer: MZMcBride <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
