[MediaWiki-commits] [Gerrit] mediawiki...PageForms[master]: Improve some parameter docs
jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/394752 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Depends-On: Icc8c9c934758c8d7101f93762288ba894f1cf015
Change-Id: I4d9c3495f3620d3c19fdde12ffd5ef7fd2604fbc
---
M .phpcs.xml
M includes/PF_AutoeditAPI.php
M includes/PF_FormEditAction.php
M includes/PF_FormField.php
M includes/PF_FormLinker.php
M includes/PF_FormPrinter.php
M includes/PF_FormUtils.php
M includes/PF_HelperFormAction.php
M includes/PF_Hooks.php
M includes/PF_PageSchemas.php
M includes/PF_ParserFunctions.php
M includes/PF_Template.php
M includes/PF_TemplateField.php
M includes/PF_TemplateInForm.php
M includes/PF_Utils.php
M includes/PF_ValuesUtils.php
M includes/forminputs/PF_CheckboxInput.php
M includes/forminputs/PF_CheckboxesInput.php
M includes/forminputs/PF_ComboBoxInput.php
M includes/forminputs/PF_DateInput.php
M includes/forminputs/PF_DatePickerInput.php
M includes/forminputs/PF_DateTimeInput.php
M includes/forminputs/PF_DateTimePicker.php
M includes/forminputs/PF_DropdownInput.php
M includes/forminputs/PF_FormInput.php
M includes/forminputs/PF_GoogleMapsInput.php
M includes/forminputs/PF_LeafletInput.php
M includes/forminputs/PF_ListBoxInput.php
M includes/forminputs/PF_OpenLayersInput.php
M includes/forminputs/PF_RadioButtonInput.php
M includes/forminputs/PF_RatingInput.php
M includes/forminputs/PF_RegExpInput.php
M includes/forminputs/PF_TextAreaInput.php
M includes/forminputs/PF_TextInput.php
M includes/forminputs/PF_TextWithAutocompleteInput.php
M includes/forminputs/PF_TimePickerInput.php
M includes/forminputs/PF_TokensInput.php
M includes/forminputs/PF_Tree.php
M includes/forminputs/PF_TreeInput.php
M includes/forminputs/PF_YearInput.php
M specials/PF_CreateForm.php
M specials/PF_FormStart.php
M specials/PF_UploadWindow.php
43 files changed, 351 insertions(+), 90 deletions(-)
Approvals:
jenkins-bot: Verified
Thiemo Kreuz (WMDE): Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index ca7cba2..76446a7 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -17,10 +17,7 @@
-
-
-
diff --git a/includes/PF_AutoeditAPI.php b/includes/PF_AutoeditAPI.php
index 5e47b9c..09ec5ec 100644
--- a/includes/PF_AutoeditAPI.php
+++ b/includes/PF_AutoeditAPI.php
@@ -54,7 +54,7 @@
}
/**
-* Returns the options array
+* @return array
*/
function getOptions() {
return $this->mOptions;
@@ -73,14 +73,15 @@
}
/**
-* Sets the options array
+* @param array $options
*/
function setOptions( $options ) {
$this->mOptions = $options;
}
/**
-* Sets an option in the options array
+* @param string $option
+* @param mixed $value
*/
function setOption( $option, $value ) {
$this->mOptions[$option] = $value;
@@ -727,6 +728,8 @@
/**
* Helper function..
+* @param Title $title
+* @return string
*/
function getTextForPage( $title ) {
$wikiPage = WikiPage::factory( $title );
@@ -1076,11 +1079,11 @@
/**
* This function recursively inserts the value into a tree.
*
-* @param $array is root
-* @param $key identifies path to position in tree.
+* @param array &$array is root
+* @param string $key identifies path to position in tree.
*Format: 1stLevelName[2ndLevel][3rdLevel][...], i.e. normal array
notation
-* @param $value: the value to insert
-* @param $toplevel: if this is a toplevel value.
+* @param mixed $value the value to insert
+* @param bool $toplevel if this is a toplevel value.
*/
public static function addToArray( &$array, $key, $value, $toplevel =
true ) {
$matches = array();
@@ -1174,7 +1177,7 @@
/**
* Returns the description string for this module
*
-* @return mixed string or array of strings
+* @return string|string[]
*/
function getDescription() {
return <page );
@@ -33,7 +34,7 @@
/**
* Execute the action in a silent fashion: do not display anything or
release any errors.
-* @return Bool whether execution was successful
+* @return bool whether execution was successful
*/
public function execute() {
return true;
@@ -42,6 +43,9 @@
/**
* Adds an "action" (i.e., a tab) to edit the
[MediaWiki-commits] [Gerrit] mediawiki...PageForms[master]: Improve some parameter docs
Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/394752 )
Change subject: Improve some parameter docs
..
Improve some parameter docs
Depends-On: Icc8c9c934758c8d7101f93762288ba894f1cf015
Change-Id: I4d9c3495f3620d3c19fdde12ffd5ef7fd2604fbc
---
M .phpcs.xml
M includes/PF_AutoeditAPI.php
M includes/PF_FormEditAction.php
M includes/PF_FormField.php
M includes/PF_FormLinker.php
M includes/PF_FormPrinter.php
M includes/PF_FormUtils.php
M includes/PF_HelperFormAction.php
M includes/PF_Hooks.php
M includes/PF_PageSchemas.php
M includes/PF_ParserFunctions.php
M includes/PF_Template.php
M includes/PF_TemplateField.php
M includes/PF_TemplateInForm.php
M includes/PF_Utils.php
M includes/PF_ValuesUtils.php
M includes/forminputs/PF_CheckboxInput.php
M includes/forminputs/PF_CheckboxesInput.php
M includes/forminputs/PF_ComboBoxInput.php
M includes/forminputs/PF_DateInput.php
M includes/forminputs/PF_DatePickerInput.php
M includes/forminputs/PF_DateTimeInput.php
M includes/forminputs/PF_DateTimePicker.php
M includes/forminputs/PF_DropdownInput.php
M includes/forminputs/PF_FormInput.php
M includes/forminputs/PF_GoogleMapsInput.php
M includes/forminputs/PF_LeafletInput.php
M includes/forminputs/PF_ListBoxInput.php
M includes/forminputs/PF_OpenLayersInput.php
M includes/forminputs/PF_RadioButtonInput.php
M includes/forminputs/PF_RatingInput.php
M includes/forminputs/PF_RegExpInput.php
M includes/forminputs/PF_TextAreaInput.php
M includes/forminputs/PF_TextInput.php
M includes/forminputs/PF_TextWithAutocompleteInput.php
M includes/forminputs/PF_TimePickerInput.php
M includes/forminputs/PF_TokensInput.php
M includes/forminputs/PF_Tree.php
M includes/forminputs/PF_TreeInput.php
M includes/forminputs/PF_YearInput.php
M specials/PF_CreateForm.php
M specials/PF_FormStart.php
M specials/PF_UploadWindow.php
43 files changed, 312 insertions(+), 36 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/PageForms
refs/changes/52/394752/1
diff --git a/.phpcs.xml b/.phpcs.xml
index 30dc330..e31acfc 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -15,10 +15,7 @@
-
-
-
diff --git a/includes/PF_AutoeditAPI.php b/includes/PF_AutoeditAPI.php
index 2f87012..d504fda 100644
--- a/includes/PF_AutoeditAPI.php
+++ b/includes/PF_AutoeditAPI.php
@@ -55,6 +55,7 @@
/**
* Returns the options array
+* @return array
*/
function getOptions() {
return $this->mOptions;
@@ -74,6 +75,7 @@
/**
* Sets the options array
+* @param array $options
*/
function setOptions( $options ) {
$this->mOptions = $options;
@@ -81,6 +83,8 @@
/**
* Sets an option in the options array
+* @param string $option
+* @param mixed $value
*/
function setOption( $option, $value ) {
$this->mOptions[$option] = $value;
@@ -727,6 +731,8 @@
/**
* Helper function..
+* @param Title $title
+* @return string
*/
function getTextForPage( $title ) {
$wikiPage = WikiPage::factory( $title );
@@ -1076,11 +1082,11 @@
/**
* This function recursively inserts the value into a tree.
*
-* @param $array is root
-* @param $key identifies path to position in tree.
+* @param array &$array is root
+* @param string $key identifies path to position in tree.
*Format: 1stLevelName[2ndLevel][3rdLevel][...], i.e. normal array
notation
-* @param $value: the value to insert
-* @param $toplevel: if this is a toplevel value.
+* @param mixed $value the value to insert
+* @param bool $toplevel if this is a toplevel value.
*/
public static function addToArray( &$array, $key, $value, $toplevel =
true ) {
$matches = [];
diff --git a/includes/PF_FormEditAction.php b/includes/PF_FormEditAction.php
index f5a2968..f66d817 100644
--- a/includes/PF_FormEditAction.php
+++ b/includes/PF_FormEditAction.php
@@ -26,6 +26,7 @@
* output. Do not use globals $wgOut, $wgRequest, etc, in
implementations; use
* $this->getOutput(), etc.
* @throws ErrorPageError
+* @return false
*/
public function show() {
return self::displayForm( $this, $this->page );
@@ -33,7 +34,7 @@
/**
* Execute the action in a silent fashion: do not display anything or
release any errors.
-* @return Bool whether execution was successful
+* @return bool whether execution was successful
*/
public function execute() {
return true;
@@ -42,6 +43,9 @@
/**
* Adds an "
