phpgroupware-cvs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Phpgroupware-cvs] addressbook/inc class.bocatalog_contact_comm_descr.in


From: powerstat
Subject: [Phpgroupware-cvs] addressbook/inc class.bocatalog_contact_comm_descr.inc.php, 1.3 class.bocatalog_contact_note_type.inc.php, 1.3 class.ipc_addressbook.inc.php, 1.3 class.boaddressbook_prefs.inc.php, 1.3 class.bocatalog_contact_comm_type.inc.php, 1.3 class.bocatalog_contact_addr_type.inc.php, 1.3 class.catalog_manager.inc.php, 1.3 class.boXport.inc.php, 1.11 class.boaddressbook.inc.php, 1.27 class.pdb.inc.php, 1.5
Date: Tue, 10 May 2005 15:55:00 +0200

Update of addressbook/inc

Modified Files:
     Branch: MAIN
            class.bocatalog_contact_comm_descr.inc.php lines: +15 -0
            class.bocatalog_contact_note_type.inc.php lines: +15 -0
            class.ipc_addressbook.inc.php lines: +7 -7
            class.boaddressbook_prefs.inc.php lines: +16 -20
            class.bocatalog_contact_comm_type.inc.php lines: +15 -0
            class.bocatalog_contact_addr_type.inc.php lines: +15 -0
            class.catalog_manager.inc.php lines: +20 -26
            class.boXport.inc.php lines: +16 -13
            class.boaddressbook.inc.php lines: +19 -22
            class.pdb.inc.php lines: +25 -36

Log Message:
Added phpdocs

====================================================
Index: addressbook/inc/class.bocatalog_contact_comm_descr.inc.php
diff -u addressbook/inc/class.bocatalog_contact_comm_descr.inc.php:1.2 
addressbook/inc/class.bocatalog_contact_comm_descr.inc.php:1.3
--- addressbook/inc/class.bocatalog_contact_comm_descr.inc.php:1.2      Fri Dec 
31 04:55:22 2004
+++ addressbook/inc/class.bocatalog_contact_comm_descr.inc.php  Tue May 10 
13:55:15 2005
@@ -1,4 +1,19 @@
 <?php
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @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 addressbook
+       * @version $Id$
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class bocatalog_contact_comm_descr
        {
                function bocatalog_contact_comm_descr()

====================================================
Index: addressbook/inc/class.bocatalog_contact_note_type.inc.php
diff -u addressbook/inc/class.bocatalog_contact_note_type.inc.php:1.2 
addressbook/inc/class.bocatalog_contact_note_type.inc.php:1.3
--- addressbook/inc/class.bocatalog_contact_note_type.inc.php:1.2       Fri Dec 
31 04:55:22 2004
+++ addressbook/inc/class.bocatalog_contact_note_type.inc.php   Tue May 10 
13:55:15 2005
@@ -1,4 +1,19 @@
 <?php
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @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 addressbook
+       * @version $Id$
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class bocatalog_contact_note_type
        {
                function bocatalog_contact_note_type()

====================================================
Index: addressbook/inc/class.ipc_addressbook.inc.php
diff -u addressbook/inc/class.ipc_addressbook.inc.php:1.2 
addressbook/inc/class.ipc_addressbook.inc.php:1.3
--- addressbook/inc/class.ipc_addressbook.inc.php:1.2   Fri Dec 31 04:55:22 2004
+++ addressbook/inc/class.ipc_addressbook.inc.php       Tue May 10 13:55:15 2005
@@ -2,19 +2,19 @@
        /**
        * IPC Layer
        *
-       * @author      Dirk Schaller <address@hidden>
-       * @copyright   Copyright (C) 2003 Free Software Foundation 
http://www.fsf.org/
-       * @license     http://www.fsf.org/licenses/gpl.html GNU General Public 
License
-       * @package     phpgwapi
-       * @subpackage  ipc
-       * @version     $Id$
+       * @author Dirk Schaller <address@hidden>
+       * @copyright Copyright (C) 2003,2005 Free Software Foundation 
http://www.fsf.org/
+       * @license http://www.fsf.org/licenses/gpl.html GNU General Public 
License
+       * @package addressbook
+       * @subpackage ipc
+       * @version $Id$
        */


        /**
        * Fassade of the adressbook application.
        *
-       * @package  notes
+       * @package addressbook
        */
        class ipc_addressbook extends ipc_
        {

====================================================
Index: addressbook/inc/class.boaddressbook_prefs.inc.php
diff -u addressbook/inc/class.boaddressbook_prefs.inc.php:1.2 
addressbook/inc/class.boaddressbook_prefs.inc.php:1.3
--- addressbook/inc/class.boaddressbook_prefs.inc.php:1.2       Fri Dec 31 
04:55:22 2004
+++ addressbook/inc/class.boaddressbook_prefs.inc.php   Tue May 10 13:55:15 2005
@@ -1,24 +1,20 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare API - Commononly used functions                             *
-  * This file written by Alex Borges <address@hidden>                        *
-  * Business Logic for addressbook preferences                               *
-  * Copyright (C) 2003 Alex Borges                                           *
-  * -------------------------------------------------------------------------*
-  * This library is part of the phpGroupWare Addressbook app                 *
-  * http://www.phpgroupware.org/                                             *
-  * ------------------------------------------------------------------------ *
-  * This library 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.                                            *
-  * This library is distributed in the hope that it will be useful, but      *
-  * WITHOUT ANY WARRANTY; without even the implied warranty of               *
-  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
-  * See the GNU General Public License for more details.                     *
-  * You should have received a copy of the GNU  General Public License       *
-  * along with this library; if not, write to the Free Software Foundation,  *
-  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
-  \**************************************************************************/
+       /**
+       * Addressbook - Business Logic for addressbook preferences
+       *
+       * @author Alex Borges <address@hidden>
+       * @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 addressbook
+       * @version $Id$
+       */
+
+
+/**
+* Business Logic for addressbook preferences
+*
+* @package addressbook
+*/
 class boaddressbook_prefs
 {
        var $preferences;

====================================================
Index: addressbook/inc/class.bocatalog_contact_comm_type.inc.php
diff -u addressbook/inc/class.bocatalog_contact_comm_type.inc.php:1.2 
addressbook/inc/class.bocatalog_contact_comm_type.inc.php:1.3
--- addressbook/inc/class.bocatalog_contact_comm_type.inc.php:1.2       Fri Dec 
31 04:55:22 2004
+++ addressbook/inc/class.bocatalog_contact_comm_type.inc.php   Tue May 10 
13:55:15 2005
@@ -1,4 +1,19 @@
 <?php
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @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 addressbook
+       * @version $Id$
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class bocatalog_contact_comm_type
        {
                function bocatalog_contact_comm_type()

====================================================
Index: addressbook/inc/class.bocatalog_contact_addr_type.inc.php
diff -u addressbook/inc/class.bocatalog_contact_addr_type.inc.php:1.2 
addressbook/inc/class.bocatalog_contact_addr_type.inc.php:1.3
--- addressbook/inc/class.bocatalog_contact_addr_type.inc.php:1.2       Fri Dec 
31 04:55:22 2004
+++ addressbook/inc/class.bocatalog_contact_addr_type.inc.php   Tue May 10 
13:55:15 2005
@@ -1,4 +1,19 @@
 <?php
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @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 addressbook
+       * @version $Id$
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class bocatalog_contact_addr_type
        {
                function bocatalog_contact_addr_type()

====================================================
Index: addressbook/inc/class.catalog_manager.inc.php
diff -u addressbook/inc/class.catalog_manager.inc.php:1.2 
addressbook/inc/class.catalog_manager.inc.php:1.3
--- addressbook/inc/class.catalog_manager.inc.php:1.2   Fri Dec 31 04:55:22 2004
+++ addressbook/inc/class.catalog_manager.inc.php       Tue May 10 13:55:15 2005
@@ -1,22 +1,21 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - catalog_manager                                           *
-  * http://www.phpgroupware.org                                              *
-  * This program is part of the GNU project, see http://www.gnu.org/         *
-  *                                                                          *
-  * Copyright 2003 Free Software Foundation, Inc.                            *
-  *                                                                          *
-  * Originally Written by Jonathan Alberto Rivera Gomez - jarg at co.com.mx  *
-  * Current Maintained by Jonathan Alberto Rivera Gomez - jarg at co.com.mx  *
-  * --------------------------------------------                             *
-  * Development of this application was funded by http://www.sogrp.com       *
-  * --------------------------------------------                             *
-  *  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.                                              *
-  \**************************************************************************/
-
+       /**
+       * Addressbook - catalog manager
+       *
+       * @author Jonathan Alberto Rivera Gomez <address@hidden>
+       * @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 addressbook
+       * @version $Id$
+       * @internal Development of this application was funded by 
http://www.sogrp.com/
+       */
+
+
+       /**
+       * Catalog manager
+       *
+       * @package addressbook
+       */
        class catalog_manager
        {
                var $form_action;
@@ -53,8 +52,9 @@
                /**
                * Start to draw the html screens
                *
-               * @param
-               * @return
+               * @param string $catalog_name
+               * @param string $entry
+               * @param string $title
                */
                function main_form($catalog_name, $entry, $title)
                {
@@ -169,9 +169,6 @@

                /**
                * This function initialize the template for draw the tabs 
windows
-               *
-               * @param
-               * @return
                */
                function form_start()
                {
@@ -182,9 +179,6 @@

                /**
                * This function end the template for draw the tabs windows
-               *
-               * @param
-               * @return
                */
                function form_end()
                {

====================================================
Index: addressbook/inc/class.boXport.inc.php
diff -u addressbook/inc/class.boXport.inc.php:1.10 
addressbook/inc/class.boXport.inc.php:1.11
--- addressbook/inc/class.boXport.inc.php:1.10  Fri Dec 31 04:55:22 2004
+++ addressbook/inc/class.boXport.inc.php       Tue May 10 13:55:15 2005
@@ -1,17 +1,20 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - addressbook                                               *
-  * http://www.phpgroupware.org                                              *
-  * Written by Joseph Engo <address@hidden>                          *
-  * --------------------------------------------                             *
-  *  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$ */
-
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @author Joseph Engo <address@hidden>
+       * @copyright Copyright (C) 2000-2005 Free Software Foundation, Inc. 
http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html GNU General Public 
License
+       * @package addressbook
+       * @version $Id$
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class boXport
        {
                var $public_functions = array(

====================================================
Index: addressbook/inc/class.boaddressbook.inc.php
diff -u addressbook/inc/class.boaddressbook.inc.php:1.26 
addressbook/inc/class.boaddressbook.inc.php:1.27
--- addressbook/inc/class.boaddressbook.inc.php:1.26    Fri Dec 31 04:55:22 2004
+++ addressbook/inc/class.boaddressbook.inc.php Tue May 10 13:55:14 2005
@@ -1,24 +1,21 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare - boaddressbook                                             *
-  * http://www.phpgroupware.org                                              *
-  * This program is part of the GNU project, see http://www.gnu.org/         *
-  *                                                                          *
-  * Copyright 2003 Free Software Foundation, Inc.                            *
-  *                                                                          *
-  * Originally Written by Jonathan Alberto Rivera Gomez - jarg at co.com.mx  *
-  * Current Maintained by Jonathan Alberto Rivera Gomez - jarg at co.com.mx  *
-  * --------------------------------------------                             *
-  * Development of this application was funded by http://www.sogrp.com       *
-  * --------------------------------------------                             *
-  *  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$ */
-
+       /**
+       * Addressbook - Business Logic for addressbook
+       *
+       * @author Jonathan Alberto Rivera Gomez <address@hidden>
+       * @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 addressbook
+       * @version $Id$
+       * @internal Development of this application was funded by 
http://www.sogrp.com/
+       */
+
+
+       /**
+       * Business Logic for addressbook
+       *
+       * @package addressbook
+       */
        class boaddressbook
        {
                var $debug = False;
@@ -266,7 +263,7 @@
                *
                * @param integer $person_id The person what you want to edit
                * @param array $fields The fields that you want
-               * @return
+               * @return unknwon
                */
                function edit_person($person_id, $fields)
                {
@@ -375,7 +372,7 @@
                *
                * @param integer $org_id The org what you want to edit
                * @param array $fields The fields that you want
-               * @return
+               * @return unknwon
                */
                function edit_org($org_id, $fields)
                {

====================================================
Index: addressbook/inc/class.pdb.inc.php
diff -u addressbook/inc/class.pdb.inc.php:1.4 
addressbook/inc/class.pdb.inc.php:1.5
--- addressbook/inc/class.pdb.inc.php:1.4       Fri Dec 31 04:55:22 2004
+++ addressbook/inc/class.pdb.inc.php   Tue May 10 13:55:15 2005
@@ -1,40 +1,29 @@
 <?php
-  /**************************************************************************\
-  * phpGroupWare API - Palm Database Access                                  *
-  * This file written by Miles Lott <address@hidden>                    *
-  * Access to palm OS database structures (?)                                *
-  * -------------------------------------------------------------------------*
-  * Portions of code from ToPTIP                                             *
-  *   Copyright (C) 2000-2001 Pierre Dittgen                                 *
-  *   This file is a translation of the txt2pdbdoc tool                      *
-  *   written in C Paul J. Lucas (address@hidden)                              
*
-  * -------------------------------------------------------------------------*
-  * This library may be part of the phpGroupWare API                         *
-  * http://www.phpgroupware.org/api                                          *
-  * ------------------------------------------------------------------------ *
-  * This library is free software; you can redistribute it and/or modify it  *
-  * under the terms of the GNU Lesser General Public License as published by *
-  * the Free Software Foundation; either version 2.1 of the License,         *
-  * or any later version.                                                    *
-  * This library is distributed in the hope that it will be useful, but      *
-  * WITHOUT ANY WARRANTY; without even the implied warranty of               *
-  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
-  * See the GNU Lesser General Public License for more details.              *
-  * You should have received a copy of the GNU Lesser General Public License *
-  * along with this library; if not, write to the Free Software Foundation,  *
-  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
-  \**************************************************************************/
-
-  /* $Id$ */
-
-       // ONLY THE FETCH FUNCTION SHOULD BE CALLED AT THIS TIME:
-       //     $pdb = CreateObject('addressbook.pdb');
-       //     $pdb->fetch($content, $title, $document);
-       //
-       // This will force a download of the pdb file.
-       //
-       // READ DOES NOT WORK
-       // FORMAT OF FILE IS A DOC, NOT A TRUE PALM ADDRESS BOOK
+       /**
+       * Addressbook - Palm Database Access
+       *
+       * Access to palm OS database structures
+       * @author Miles Lott <address@hidden>
+       * @copyright Copyright (C) 2000-2001,2004-2005 Free Software 
Foundation, Inc. http://www.fsf.org/
+       * @license http://www.gnu.org/licenses/gpl.html LGNU Lesser General 
Public License
+       * @package addressbook
+       * @version $Id$
+       * @internal Portions of code from ToPTIP; Copyright (C) 2000-2001 
Pierre Dittgen;
+       * @internal This file is a translation of the txt2pdbdoc tool; written 
in C Paul J. Lucas (address@hidden)
+       * @internal ONLY THE FETCH FUNCTION SHOULD BE CALLED AT THIS TIME:
+       * @internal $pdb = CreateObject('addressbook.pdb');
+       * @internal $pdb->fetch($content, $title, $document);
+       * @internal This will force a download of the pdb file.
+       * @internal READ DOES NOT WORK
+       * @internal FORMAT OF FILE IS A DOC, NOT A TRUE PALM ADDRESS BOOK
+       */
+
+
+       /**
+       * Palm Database Access
+       *
+       * @package addressbook
+       */
        class pdb
        {
                var $record_size                        = 4096; // Size of text 
record






reply via email to

[Prev in Thread] Current Thread [Next in Thread]