[Phpgroupware-cvs] email/inc class.boattach_file.inc.php, 1.7 class.bofilters.inc.php, 1.17 class.boindex.inc.php, 1.33 class.bofolder.inc.php, 1.11 class.bocompose.inc.php, 1.11

[powerstat]

Update of email/inc

Modified Files:
     Branch: MAIN
            class.boattach_file.inc.php lines: +18 -20
            class.bofilters.inc.php lines: +16 -36
            class.boindex.inc.php lines: +17 -13
            class.bofolder.inc.php lines: +16 -12
            class.bocompose.inc.php lines: +17 -18

Log Message:
Added phpdocs

====================================================
Index: email/inc/class.boattach_file.inc.php
diff -u email/inc/class.boattach_file.inc.php:1.6 
email/inc/class.boattach_file.inc.php:1.7
--- email/inc/class.boattach_file.inc.php:1.6   Sun Mar 13 23:22:43 2005
+++ email/inc/class.boattach_file.inc.php       Wed May 11 14:23:59 2005
@@ -1,26 +1,24 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - email BO Class for Attaching Files                        
                        *
-       * http://www.anglemail.org                                              
                        *
-       * File adapted directly from phpGroupWare file email/attach_file.php    
        *
-       * http://www.phpgroupware.org                                           
                        *
-       * That file was authored by Joseph Engo <address@hidden>                
*
-       * Previous Maintainer notes that server side file handling was borrowed 
        *
-       * from Squirrelmail circa 2000-2001                                     
                        *
-       * http://www.squirrelmail.org                                           
                        *
-       * Some refinements and code modernization to that file were made by     
        *
-       * Angelo "Angles" Puglisi <address@hidden>                              
*
-       * Then Anglemail made the code a "BO" class object. (this file)         
        *
-       * AngleMail appreciates all the work of previous authors of this file.  
        *
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                *
-       
\**************************************************************************/
+       /**
+       * EMail - Attaching Files
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @author Joseph Engo <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       * @internal Squirrelmail circa 2000-2001 http://www.squirrelmail.org
+       */

-       /* $Id$ */

+       /**
+       * Attaching Files
+       *
+       * @package email
+       */
        class boattach_file
        {
                var $public_functions = array(

====================================================
Index: email/inc/class.bofilters.inc.php
diff -u email/inc/class.bofilters.inc.php:1.16 
email/inc/class.bofilters.inc.php:1.17
--- email/inc/class.bofilters.inc.php:1.16      Sun Mar 13 23:22:43 2005
+++ email/inc/class.bofilters.inc.php   Wed May 11 14:23:59 2005
@@ -1,41 +1,21 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - E-Mail Filters                                            
                        *
-       * http://www.anglemail.org                                              
                        *
-       * Written by Angelo (Angles) Puglisi <address@hidden>           *
-       * Copyright (C) 2001, 2002 Angelo Puglisi (Angles)                      
                *
-       * -----------------------------------------------                       
                                *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                                *
-       
\**************************************************************************/
-
-       /* $Id$ */
+       /**
+       * EMail - Filters
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */
+

-       /*!
-       @class bofilters
-       @abstract BO functions for email filters
-       @author Angles
-       @param $not_set (string) always a string that it "-1"
-       @param $all_filters (array)
-       @param $filter_num (int)
-       @param $add_new_filter_token (string)  "add_new"
-       @param $template (object)
-       @param $finished_mlist ?
-       @param $submit_mlist_to_class_form ?
-       @param $debug (int) 0 to 3
-       @param $debug_set_prefs (int) 0 to 3
-       @param $examine_imap_search_keys_map (array)
-       @param $match_keeper_row_values (array)
-       @param $result_set (array)
-       @param $result_set_mlist (array)
-       @param $fake_folder_info (array)
-       @param $do_filter_apply_all (boolean)
-       @param $inbox_full_msgball_list (array)
-       @param $each_filter_mball_list  (array)
-       @param $html_matches_table (string)
-       @access pubic
+       /**
+       * Filters
+       *
+       * @package email
        */
        class bofilters
        {

====================================================
Index: email/inc/class.boindex.inc.php
diff -u email/inc/class.boindex.inc.php:1.32 
email/inc/class.boindex.inc.php:1.33
--- email/inc/class.boindex.inc.php:1.32        Sun Mar 13 23:22:43 2005
+++ email/inc/class.boindex.inc.php     Wed May 11 14:23:59 2005
@@ -1,18 +1,22 @@
 <?php
-       
/**************************************************************************\
-       * Anglemail - email BO Class for Message Lists                          
*
-       * http://www.anglemail.org                                              
        *
-       * Written by Angelo (Angles) Puglisi <address@hidden>           *
-       * Copyright 2001, 2002 Angelo "Angles" Puglisi
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                *
-       
\**************************************************************************/
-
-       /* $Id$ */
+       /**
+       * EMail - Message Lists
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */
+

+       /**
+       * Message Lists
+       *
+       * @package email
+       */
        class boindex
        {
                var $public_functions = array(

====================================================
Index: email/inc/class.bofolder.inc.php
diff -u email/inc/class.bofolder.inc.php:1.10 
email/inc/class.bofolder.inc.php:1.11
--- email/inc/class.bofolder.inc.php:1.10       Sun Mar 13 23:22:43 2005
+++ email/inc/class.bofolder.inc.php    Wed May 11 14:23:59 2005
@@ -1,18 +1,22 @@
 <?php
-       
/**************************************************************************\
-       * AngleMail - email BO Class    for Folder Actions and List Display     
        *
-       * http://www.anglemail.org                                              
        *
-       * Written by Angelo (Angles) Puglisi <address@hidden>           *
-       * Copyright 2001, 2003 Angelo (Angles) Puglisi                          
*
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                *
-       
\**************************************************************************/
+       /**
+       * EMail - Folder Actions and List Display
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2003 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
+       */

-       /* $Id$ */

+       /**
+       * Folder Actions and List Display
+       *
+       * @package email
+       */
        class bofolder
        {
                var $public_functions = array(

====================================================
Index: email/inc/class.bocompose.inc.php
diff -u email/inc/class.bocompose.inc.php:1.10 
email/inc/class.bocompose.inc.php:1.11
--- email/inc/class.bocompose.inc.php:1.10      Sun Mar 13 23:22:43 2005
+++ email/inc/class.bocompose.inc.php   Wed May 11 14:23:59 2005
@@ -1,23 +1,22 @@
 <?php
-       
/**************************************************************************\
-       * Anglemail - email BO Class Compose and SpellCheck                     
*
-       * http://www.anglemail.org                                              
                *
-       * Written by Angelo (Angles) Puglisi <address@hidden>           *
-       * Copyright 2001, 2002 Angelo "Angles" Puglisi
-       * --------------------------------------------                          
                        *
-       *  This program is free software; you can redistribute it and/or modify 
it              *
-       *  under the terms of the GNU General Public License as published by 
the        *
-       *  Free Software Foundation; either version 2 of the License, or (at 
your               *
-       *  option) any later version.                                           
                                *
-       
\**************************************************************************/
-
-       /* $Id$ */
-
-       /*!
-       @class bocompose
-       @abstract guts of compose logic is in here
-       @ discussion ?
+       /**
+       * EMail - Compose and SpellCheck
+       *
+       * @author Angelo (Angles) Puglisi <address@hidden>
+       * @copyright Copyright (C) 2001-2002 Angelo Tony Puglisi (Angles)
+       * @copyright Copyright (C) 2003-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package email
+       * @version $Id$
+       * @internal Based on AngleMail http://www.anglemail.org/
        */
+
+
+       /**
+       * Compose and SpellCheck
+       *
+       * @package email
+       */
        class bocompose
        {
                var $public_functions = array(