MDL-80820 lib/pear: phpdoc corrections

TM2020 · Apr 8, 2024 · 42c76b7 · 42c76b7
1 parent ef1759d
commit 42c76b7
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 7 deletions.
diff --git a/lib/filelib.php b/lib/filelib.php
@@ -3962,7 +3962,7 @@ private function trigger_url_blocked_event($url, $reason, $redirect = false): vo
         $event->trigger();
     }
 
-     /**
+    /**
      * HTTP HEAD method
      *
      * @see request()

diff --git a/lib/form/group.php b/lib/form/group.php
@@ -60,7 +60,7 @@ class MoodleQuickForm_group extends HTML_QuickForm_group implements templatable
      * @param string $elementName (optional) name of the group
      * @param string $elementLabel (optional) group label
      * @param array $elements (optional) array of HTML_QuickForm_element elements to group
-     * @param string $separator (optional) string to seperate elements.
+     * @param string|array $separator (optional) Use a string for one separator, or use an array to alternate the separators
      * @param string $appendName (optional) string to appened to grouped elements.
      * @param mixed $attributes (optional) Either a typical HTML attribute string
      *              or an associative array

diff --git a/lib/pear/HTML/QuickForm.php b/lib/pear/HTML/QuickForm.php
@@ -721,7 +721,7 @@ function &insertElementBefore(&$element, $nameAfter)
      * @param    array      $elements       array of elements composing the group
      * @param    string     $name           (optional)group name
      * @param    string     $groupLabel     (optional)group label
-     * @param    string     $separator      (optional)string to separate elements
+     * @param    string|array $separator    (optional) Use a string for one separator, or use an array to alternate the separators
      * @param    bool       $appendName     (optional)specify whether the group name should be
      *                                      used in the form element name ex: group[element]
      * @param     mixed     $attributes     Either a typical HTML attribute string or an associative array
@@ -904,7 +904,7 @@ function _reindexFiles($value, $key)
      * @param     string    $element        Name of form element to check
      * @since     1.0
      * @access    public
-     * @return    string    error message corresponding to checked element
+     * @return    ?string    error message corresponding to checked element
      */
     function getElementError($element)
     {
@@ -1242,7 +1242,7 @@ function applyFilter($element, $filter)
      * @param     mixed    $value     submitted values
      * @since     2.0
      * @access    private
-     * @return    cleaned values
+     * @return    mixed cleaned values
      */
     function _recursiveFilter($filter, $value)
     {

diff --git a/lib/pear/HTML/QuickForm/group.php b/lib/pear/HTML/QuickForm/group.php
@@ -392,7 +392,7 @@ function getFrozenHtml()
      * @param     object    $caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    ?bool
      */
     function onQuickFormEvent($event, $arg, &$caller)
     {

diff --git a/lib/pear/readme_moodle.txt b/lib/pear/readme_moodle.txt
@@ -40,6 +40,7 @@ MDL-78145 - PHP 8.2 compliance. Added a missing class property that still need t
             And also remove the $_elementIdx because it is not needed in Moodle code.
 MDL-78527 - Adding a sixth parameter to allow groups to use attributes.
 MDL-80818 - Freezing all elements with the same name (e.g. radio buttons)
+MDL-80820 - PHPdocs corrections
 
 Pear
 ====

diff --git a/mod/data/tests/generator/lib.php b/mod/data/tests/generator/lib.php
@@ -85,7 +85,7 @@ public function create_instance($record = null, array $options = null) {
     /**
      * Creates a field for a mod_data instance.
      *
-     * @param stdClass|array $record
+     * @param stdClass $record
      * @param stdClass|null $data
      * @return data_field_base
      */
-Original file line number
+Diff line change
@@ Expand Up @@
             $event->trigger();
         }
-         /**
+        /**
          * HTTP HEAD method
          *
          * @see request()
@@ Expand Down @@