diff --git a/htdocs/core/class/html.formsetup.class.php b/htdocs/core/class/html.formsetup.class.php
index 1778b46995e..25ab99bfe01 100644
--- a/htdocs/core/class/html.formsetup.class.php
+++ b/htdocs/core/class/html.formsetup.class.php
@@ -105,8 +105,9 @@ class FormSetup
/**
* Generate an attributes string form an input array
- * @param array $attributes an array of attributes keys and values,
- * @return string
+ *
+ * @param array $attributes an array of attributes keys and values,
+ * @return string attribute string
*/
static public function generateAttributesStringFromArray($attributes)
{
@@ -125,8 +126,10 @@ class FormSetup
/**
- * @param bool $editMode true will display output on edit mod
- * @return string
+ * generateOutput
+ *
+ * @param bool $editMode true will display output on edit mod
+ * @return string html output
*/
public function generateOutput($editMode = false)
{
@@ -188,8 +191,10 @@ class FormSetup
}
/**
- * @param bool $editMode true will display output on edit mod
- * @return string
+ * generateTableOutput
+ *
+ * @param bool $editMode true will display output on edit mod
+ * @return string html output
*/
public function generateTableOutput($editMode = false)
{
@@ -230,12 +235,13 @@ class FormSetup
}
/**
- * @param bool $noMessageInUpdate display event message on errors and success
- * @return void|null
+ * saveConfFromPost
+ *
+ * @param bool $noMessageInUpdate display event message on errors and success
+ * @return void|null
*/
public function saveConfFromPost($noMessageInUpdate = false)
{
-
if (empty($this->items)) {
return null;
}
@@ -266,9 +272,11 @@ class FormSetup
}
/**
- * @param FormSetupItem $item the setup item
- * @param bool $editMode Display as edit mod
- * @return string the html output for an setup item
+ * generateLineOutput
+ *
+ * @param FormSetupItem $item the setup item
+ * @param bool $editMode Display as edit mod
+ * @return string the html output for an setup item
*/
public function generateLineOutput($item, $editMode = false)
{
@@ -306,8 +314,9 @@ class FormSetup
/**
- * @param array $params an array of arrays of params from old modulBuilder params
- * @deprecated was used to test module builder convertion to this form usage
+ * Method used to test module builder convertion to this form usage
+ *
+ * @param array $params an array of arrays of params from old modulBuilder params
* @return null
*/
public function addItemsFromParamsArray($params)
@@ -321,10 +330,11 @@ class FormSetup
/**
* From old
- * @param string $confKey the conf name to store
- * @param array $params an array of params from old modulBuilder params
- * @deprecated was used to test module builder convertion to this form usage
- * @return bool
+ * Method was used to test module builder convertion to this form usage.
+ *
+ * @param string $confKey the conf name to store
+ * @param array $params an array of params from old modulBuilder params
+ * @return bool
*/
public function addItemFromParams($confKey, $params)
{
@@ -359,9 +369,10 @@ class FormSetup
}
/**
- * used to export param array for /core/actions_setmoduleoptions.inc.php template
+ * Used to export param array for /core/actions_setmoduleoptions.inc.php template
+ * Method exists only for manage setup convertion
+ *
* @return array $arrayofparameters for /core/actions_setmoduleoptions.inc.php
- * @deprecated yes this method came deprecated because it exists only for manage setup convertion
*/
public function exportItemsAsParamsArray()
{
@@ -379,6 +390,7 @@ class FormSetup
/**
* Reload for each item default conf
* note: this will override custom configuration
+ *
* @return bool
*/
public function reloadConfs()
@@ -396,9 +408,10 @@ class FormSetup
/**
* Create a new item
* the tagret is useful with hooks : that allow externals modules to add setup items on good place
- * @param $confKey the conf key used in database
- * @param string $targetItemKey target item used to place the new item beside
- * @param bool $insertAfterTarget insert before or after target item ?
+ *
+ * @param string $confKey the conf key used in database
+ * @param string $targetItemKey target item used to place the new item beside
+ * @param bool $insertAfterTarget insert before or after target item ?
* @return FormSetupItem the new setup item created
*/
public function newItem($confKey, $targetItemKey = false, $insertAfterTarget = false)
@@ -436,6 +449,7 @@ class FormSetup
/**
* Sort items according to rank
+ *
* @return bool
*/
public function sortingItems()
@@ -445,6 +459,8 @@ class FormSetup
}
/**
+ * getCurentItemMaxRank
+ *
* @param bool $cache To use cache or not
* @return int
*/
@@ -469,8 +485,9 @@ class FormSetup
/**
* set new max rank if needed
- * @param int $rank the item rank
- * @return int|void
+ *
+ * @param int $rank the item rank
+ * @return int|void new max rank
*/
public function setItemMaxRank($rank)
{
@@ -479,10 +496,10 @@ class FormSetup
/**
- * get item position rank from item key
+ * get item position rank from item key
*
- * @param string $itemKey the item key
- * @return int rank on success and -1 on error
+ * @param string $itemKey the item key
+ * @return int rank on success and -1 on error
*/
public function getLineRank($itemKey)
{
@@ -498,7 +515,7 @@ class FormSetup
*
* @param FormSetupItem $a formSetup item
* @param FormSetupItem $b formSetup item
- * @return int Return compare result
+ * @return int Return compare result
*/
public function itemSort(FormSetupItem $a, FormSetupItem $b)
{