adding phpdoc blocks to sqimap_mailbox_list function

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9082 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php
index 30ecbd5ff40bc7632f6ccb3f97a3db5104efd799..b37f6aa8981c0fe04762c8f2dde0e059f58a4a74 100755 (executable)
--- a/functions/imap_mailbox.php
+++ b/functions/imap_mailbox.php
@@ -555,9 +555,10 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk
 /**
  * Returns sorted mailbox lists in several different ways.
  * See comment on sqimap_mailbox_parse() for info about the returned array.
 /**
  * Returns sorted mailbox lists in several different ways.
  * See comment on sqimap_mailbox_parse() for info about the returned array.

+ * @param resource $imap_stream imap connection resource
+ * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
+ * @return array list of mailboxes

  */
  */

-
-

 function sqimap_mailbox_list($imap_stream, $force=false) {
     if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
         global $data_dir, $username, $list_special_folders_first,
 function sqimap_mailbox_list($imap_stream, $force=false) {
     if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
         global $data_dir, $username, $list_special_folders_first,