docs: fix docblocks

Signed-off-by: btry <tbugier@teclib.com>
pluginsGLPI · Aug 7, 2018 · 3e1688a · 3e1688a
1 parent f1606af
commit 3e1688a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/inc/field.class.php b/inc/field.class.php
@@ -72,12 +72,6 @@ public function prepareQuestionInputForTarget($input) {
       return Toolbox::addslashes_deep($input);
    }
 
-   /**
-    * Prepares a default value or set of values for question edition
-    *
-    * @param  string $input
-    * @return string
-    */
    public function prepareQuestionValuesForEdit($input) {
       return $input;
    }

diff --git a/inc/fieldinterface.class.php b/inc/fieldinterface.class.php
@@ -41,5 +41,12 @@ public static function getPrefs();
    public static function getJSFields();
    public function prepareQuestionInputForSave($input);
    public function prepareQuestionInputForTarget($input);
-   public function prepareQuestionValuesForEdit($input);
+
+   /**
+    * Prepares a default value or set of values for question edition
+    *
+    * @param  string $input
+    * @return string
+    */
+    public function prepareQuestionValuesForEdit($input);
 }
diff --git a/inc/fields.class.php b/inc/fields.class.php
@@ -330,10 +330,10 @@ public static function updateVisibility($currentValues) {
    }
 
    /**
-    * checks if a field type exists
+    * gets the classname for a field given its type
     *
     * @param string $type type of field to test for existence
-    * @return boolean
+    * @return string
     */
    public static function getFieldClassname($type) {
       return 'PluginFormcreator' . ucfirst($type) . 'Field';
@@ -355,6 +355,7 @@ public static function fieldTypeExists($type) {
     * @param string $type type of field to get
     * @param PluginFormcreatorQuestion $question question representing the field
     * @param array $data additional data
+    * @return null|PluginFormcreatorFieldInterface
     */
    public static function getFieldInstance($type, PluginFormcreatorQuestion $question, $data = []) {
       $className = self::getFieldClassname($type);