Fix PHPDoc

roundcube · Feb 18, 2022 · 78b3049 · 78b3049
1 parent d316875
commit 78b3049
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 21 deletions.
diff --git a/program/lib/Roundcube/rcube_addressbook.php b/program/lib/Roundcube/rcube_addressbook.php
@@ -471,7 +471,7 @@ function delete_all($with_groups = false)
      * This filter mechanism is applied in addition to other filter mechanisms, see the description of the count()
      * operation.
      *
-     * @param null|0|string $gid Database identifier of the group. 0/"0"/null to reset the group filter.
+     * @param null|int|string $gid Database identifier of the group. Use 0/"0"/null to reset the group filter.
      */
     function set_group($group_id)
     {

diff --git a/program/lib/Roundcube/rcube_html2text.php b/program/lib/Roundcube/rcube_html2text.php
@@ -139,7 +139,7 @@ class rcube_html2text
      * used in conjunction with $replace.
      *
      * @var array $search
-     * @see $replace
+     * @see self::$replace
      */
     protected $search = [
         '/\r/',                                  // Non-legal carriage return
@@ -168,7 +168,7 @@ class rcube_html2text
      * List of pattern replacements corresponding to patterns searched.
      *
      * @var array $replace
-     * @see $search
+     * @see self::$search
      */
     protected $replace = [
         '',                                     // Non-legal carriage return
@@ -198,7 +198,7 @@ class rcube_html2text
      * used in conjunction with $ent_replace.
      *
      * @var array $ent_search
-     * @see $ent_replace
+     * @see self::$ent_replace
      */
     protected $ent_search = [
         '/&(nbsp|#160);/i',                      // Non-breaking space
@@ -222,7 +222,7 @@ class rcube_html2text
      * List of pattern replacements corresponding to patterns searched.
      *
      * @var array $ent_replace
-     * @see $ent_search
+     * @see self::$ent_search
      */
     protected $ent_replace = [
         "\xC2\xA0",                             // Non-breaking space
@@ -259,7 +259,7 @@ class rcube_html2text
      * used in conjunction with $pre_replace.
      *
      * @var array $pre_search
-     * @see $pre_replace
+     * @see self::$pre_replace
      */
     protected $pre_search = [
         "/\n/",
@@ -273,7 +273,7 @@ class rcube_html2text
      * List of pattern replacements corresponding to patterns searched for PRE body.
      *
      * @var array $pre_replace
-     * @see $pre_search
+     * @see self::$pre_search
      */
     protected $pre_replace = [
         '<br>',
@@ -294,7 +294,7 @@ class rcube_html2text
      * Contains a list of HTML tags to allow in the resulting text.
      *
      * @var string $allowed_tags
-     * @see set_allowed_tags()
+     * @see self::set_allowed_tags()
      */
     protected $allowed_tags = '';
 
@@ -309,15 +309,16 @@ class rcube_html2text
      * Indicates whether content in the $html variable has been converted yet.
      *
      * @var bool $_converted
-     * @see $html, $text
+     * @see self::$html
+     * @see self::$text
      */
     protected $_converted = false;
 
     /**
      * Contains URL addresses from links to be rendered in plain text.
      *
      * @var array $_link_list
-     * @see _build_link_list()
+     * @see self::_build_link_list()
      */
     protected $_link_list = [];
 
@@ -328,7 +329,6 @@ class rcube_html2text
      * - 2 if the link should be displayed to the original point in the text they appeared
      *
      * @var int $_links_mode
-     * @see __construct()
      */
     protected $_links_mode = 1;
 

diff --git a/program/lib/Roundcube/rcube_imap.php b/program/lib/Roundcube/rcube_imap.php
@@ -1483,10 +1483,10 @@ public function index($folder = '', $sort_field = null, $sort_order = null,
      * Return sorted list of message UIDs ignoring current search settings.
      * Doesn't uses cache by default.
      *
-     * @param string         $folder     Folder to get index from
-     * @param string         $sort_field Sort column
-     * @param string         $sort_order Sort order [ASC, DESC]
-     * @param rcube_result_* $search     Optional messages set to limit the result
+     * @param string             $folder     Folder to get index from
+     * @param string             $sort_field Sort column
+     * @param string             $sort_order Sort order [ASC, DESC]
+     * @param rcube_result_index $search     Optional messages set to limit the result
      *
      * @return rcube_result_index Sorted list of message UIDs
      */

diff --git a/program/lib/Roundcube/rcube_message.php b/program/lib/Roundcube/rcube_message.php
@@ -79,8 +79,6 @@ class rcube_message
      * @param string $uid     The message UID.
      * @param string $folder  Folder name
      * @param bool   $is_safe Security flag
-     *
-     * @see self::$app, self::$storage, self::$opt, self::$parts
      */
     function __construct($uid, $folder = null, $is_safe = false)
     {

diff --git a/program/lib/Roundcube/rcube_result_multifolder.php b/program/lib/Roundcube/rcube_result_multifolder.php
@@ -87,9 +87,9 @@ protected function append_result($result)
     /**
      * Store a global index of (sorted) message UIDs
      *
-     * @param 
-     * @param string $sort_field Header field to sort by
-     * @param string $sort_order Sort order
+     * @param rcube_message_header[] $headers    Messages in the index
+     * @param string                 $sort_field Header field to sort by
+     * @param string                 $sort_order Sort order
      */
     public function set_message_index($headers, $sort_field, $sort_order)
     {
@@ -290,7 +290,7 @@ public function get_parameters($param=null)
      *
      * @param string $folder Folder name
      *
-     * @return false|rcube_result_* instance of false if none found
+     * @return false|rcube_result_index|rcube_result_thread A result set or false if none found
      */
     public function get_set($folder)
     {