From db4b3bd6eb5bc360f8f2ab1aec98288a3e446ffa Mon Sep 17 00:00:00 2001
From: Gerrit Uitslag <klapinklapin@gmail.com>
Date: Thu, 4 Jan 2024 00:14:23 +0100
Subject: [PATCH] use ul li in phpdocs for arrays

---
 Search.php | 89 ++++++++++++++++++++++++++++--------------------------
 1 file changed, 46 insertions(+), 43 deletions(-)

diff --git a/Search.php b/Search.php
index 252bfff..5ffa605 100644
--- a/Search.php
+++ b/Search.php
@@ -195,21 +195,22 @@ private function makeNodes(&$data, $indexLatestParsedItem, $previousLevel, &$nod
      * Search pages/folders depending on the given options $opts
      *
      * @param string $ns
-     * @param array $opts
-     *  $opts['skipns'] string regexp matching namespaceids to skip (ignored)
-     *  $opts['skipfile']  string regexp matching pageids to skip (ignored)
-     *  $opts['skipnscombined'] array regexp matching namespaceids to skip
-     *  $opts['skipfilecombined']  array regexp matching pageids to skip
-     *  $opts['headpage']   string headpages options or pageids
-     *  $opts['level']      int    desired depth of main namespace, -1 = all levels
-     *  $opts['subnss']     array with entries: array(namespaceid,level) specifying namespaces with their own number of
-     *                            opened levels
-     *  $opts['nons']       bool   exclude namespace nodes
-     *  $opts['max']        int    If initially closed, the node at max level will retrieve all its child nodes through
-     *                             the AJAX mechanism
-     *  $opts['nopg']       bool   exclude page nodes
-     *  $opts['hide_headpage'] int don't hide (0) or hide (1)
-     *  $opts['js']         bool   use js-render (only used for old 'searchIndexmenuItems')
+     * @param array $opts<ul>
+     *  <li>$opts['skipns'] string regexp matching namespaceids to skip (ignored)</li>
+     *  <li>$opts['skipfile']  string regexp matching pageids to skip (ignored)</li>
+     *  <li>$opts['skipnscombined'] array regexp matching namespaceids to skip</li>
+     *  <li>$opts['skipfilecombined']  array regexp matching pageids to skip</li>
+     *  <li>$opts['headpage']   string headpages options or pageids</li>
+     *  <li>$opts['level']      int    desired depth of main namespace, -1 = all levels</li>
+     *  <li>$opts['subnss']     array with entries: array(namespaceid,level) specifying namespaces with their own number of
+     *                            opened levels</li>
+     *  <li>$opts['nons']       bool   exclude namespace nodes</li>
+     *  <li>$opts['max']        int    If initially closed, the node at max level will retrieve all its child nodes through</li>
+     *                             the AJAX mechanism</li>
+     *  <li>$opts['nopg']       bool   exclude page nodes</li>
+     *  <li>$opts['hide_headpage'] int don't hide (0) or hide (1)</li>
+     *  <li>$opts['js']         bool   use js-render (only used for old 'searchIndexmenuItems')</li>
+     * </ul>
      * @return array The results of the search
      */
     public function search($ns, $opts): array
@@ -241,21 +242,22 @@ public function search($ns, $opts): array
      * @param string $file Current file or directory relative to $base
      * @param string $type Type either 'd' for directory or 'f' for file
      * @param int $lvl Current recursion depth
-     * @param array $opts Option array as given to search():
-     *   $opts['skipns'] string regexp matching namespaceids to skip (ignored),
-     *   $opts['skipfile'] string regexp matching pageids to skip (ignored),
-     *   $opts['skipnscombined'] array regexp matching namespaceids to skip,
-     *   $opts['skipfilecombined'] array regexp matching pageids to skip,
-     *   $opts['headpage'] string headpages options or pageids,
-     *   $opts['level'] int desired depth of main namespace, -1 = all levels,
-     *   $opts['subnss'] array with entries: array(namespaceid,level) specifying namespaces with their own number of o
-     *                   pened levels,
-     *   $opts['nons'] bool Exclude namespace nodes,
-     *   $opts['max'] int If initially closed, the node at max level will retrieve all its child nodes through the AJAX
-     *                    mechanism,
-     *   $opts['nopg'] bool Exclude page nodes,
-     *   $opts['hide_headpage'] int don't hide (0) or hide (1),
-     *   $opts['js'] bool use js-render
+     * @param array $opts Option array as given to search():<ul>
+     *   <li>$opts['skipns'] string regexp matching namespaceids to skip (ignored),</li>
+     *   <li>$opts['skipfile'] string regexp matching pageids to skip (ignored),</li>
+     *   <li>$opts['skipnscombined'] array regexp matching namespaceids to skip,</li>
+     *   <li>$opts['skipfilecombined'] array regexp matching pageids to skip,</li>
+     *   <li>$opts['headpage'] string headpages options or pageids,</li>
+     *   <li>$opts['level'] int desired depth of main namespace, -1 = all levels,</li>
+     *   <li>$opts['subnss'] array with entries: array(namespaceid,level) specifying namespaces with their own number of o
+     *                   pened levels,</li>
+     *   <li>$opts['nons'] bool Exclude namespace nodes,</li>
+     *   <li>$opts['max'] int If initially closed, the node at max level will retrieve all its child nodes through the AJAX
+     *                    mechanism,</li>
+     *   <li>$opts['nopg'] bool Exclude page nodes,</li>
+     *   <li>$opts['hide_headpage'] int don't hide (0) or hide (1),</li>
+     *   <li>$opts['js'] bool use js-render</li>
+     * </ul>
      * @return bool if this directory should be traversed (true) or not (false)
      *
      * @author  Andreas Gohr <andi@splitbrain.org>
@@ -404,19 +406,20 @@ public function searchIndexmenuItems(&$data, $base, $file, $type, $lvl, $opts)
      * @param string $file Current file or directory relative to $base
      * @param string $type Type either 'd' for directory or 'f' for file
      * @param int $lvl Current recursion depth
-     * @param array $opts Option array as given to search()
-     *   $opts['skipns'] string regexp matching namespaceids to skip (ignored)
-     *   $opts['skipfile']  string regexp matching pageids to skip (ignored)
-     *   $opts['skipnscombined'] array regexp matching namespaceids to skip
-     *   $opts['skipfilecombined'] array regexp matching pageids to skip
-     *   $opts['headpage']   string headpages options or pageids
-     *   $opts['level']      int    desired depth of main namespace, -1 = all levels
-     *   $opts['subnss']     array with entries: array(namespaceid,level) specifying namespaces with their own level
-     *   $opts['nons']       bool   exclude namespace nodes
-     *   $opts['max']        int    If initially closed, the node at max level will retrieve all its child nodes
-     *                              through the AJAX mechanism
-     *   $opts['nopg']       bool   exclude page nodes
-     *   $opts['hide_headpage'] int don't hide (0) or hide (1)
+     * @param array $opts Option array as given to search()<ul>
+     *   <li>$opts['skipns'] string regexp matching namespaceids to skip (ignored)</li>
+     *   <li>$opts['skipfile']  string regexp matching pageids to skip (ignored)</li>
+     *   <li>$opts['skipnscombined'] array regexp matching namespaceids to skip</li>
+     *   <li>$opts['skipfilecombined'] array regexp matching pageids to skip</li>
+     *   <li>$opts['headpage']   string headpages options or pageids</li>
+     *   <li>$opts['level']      int    desired depth of main namespace, -1 = all levels</li>
+     *   <li>$opts['subnss']     array with entries: array(namespaceid,level) specifying namespaces with their own level</li>
+     *   <li>$opts['nons']       bool   exclude namespace nodes</li>
+     *   <li>$opts['max']        int    If initially closed, the node at max level will retrieve all its child nodes
+     *                              through the AJAX mechanism</li>
+     *   <li>$opts['nopg']       bool   exclude page nodes</li>
+     *   <li>$opts['hide_headpage'] int don't hide (0) or hide (1)</li>
+     * </ul>
      * @return bool if this directory should be traversed (true) or not (false)
      *
      * @author  Andreas Gohr <andi@splitbrain.org>