From 04107213faada624e58c82712ce1429a9d6db8a2 Mon Sep 17 00:00:00 2001
From: thomasb <thomasb@208e9e7b-5314-0410-a742-e7e81cd9613c>
Date: Tue, 7 Aug 2007 21:02:12 +0000
Subject: Documentation, code style and cleanup

git-svn-id: https://svn.roundcube.net/trunk@666 208e9e7b-5314-0410-a742-e7e81cd9613c
---
 roundcubemail/program/include/rcube_contacts.inc | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'roundcubemail/program/include/rcube_contacts.inc')

diff --git a/roundcubemail/program/include/rcube_contacts.inc b/roundcubemail/program/include/rcube_contacts.inc
index c6dc40dfd..9ba965e2f 100644
--- a/roundcubemail/program/include/rcube_contacts.inc
+++ b/roundcubemail/program/include/rcube_contacts.inc
@@ -19,6 +19,12 @@
 
 */
 
+
+/**
+ * Model class for the local address book database
+ *
+ * @package Addressbook
+ */
 class rcube_contacts
 {
   var $db = null;
@@ -55,7 +61,7 @@ class rcube_contacts
   /**
    * PHP 4 object constructor
    *
-   * @see  rcube_contacts::__construct
+   * @see rcube_contacts::__construct()
    */
   function rcube_contacts($dbconn, $user)
   {
@@ -125,6 +131,7 @@ class rcube_contacts
    * List the current set of contact records
    *
    * @param  array  List of cols to show
+   * @param  int    Only return this number of records, use negative values for tail
    * @return array  Indexed list of contact records, each a hash array
    */
   function list_records($cols=null, $subset=0)
-- 
cgit v1.2.3