[Commit-womb] addressbook ChangeLog addressbook.el

[Jose E. Marchesi]

CVSROOT:        /cvsroot/womb
Module name:    addressbook
Changes by:     Jose E. Marchesi <jemarch>      07/05/06 18:16:42

Modified files:
        .              : ChangeLog addressbook.el 

Log message:
        new docstring for `addrbook-set-custom-properties'

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/addressbook/ChangeLog?cvsroot=womb&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/addressbook/addressbook.el?cvsroot=womb&r1=1.5&r2=1.6

Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/womb/addressbook/ChangeLog,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- ChangeLog   6 May 2007 18:06:39 -0000       1.6
+++ ChangeLog   6 May 2007 18:16:42 -0000       1.7
@@ -3,6 +3,7 @@
        * addressbook.el: `addrbook-custom-properties' removed.
        (addrbook-build-custom-property-group): New function.
        (addrbook-set-custom-properties): New function.
+       (addrbook-set-custom-properties): Added doc string.
 
 2007-05-05  Xavier Maillard  <address@hidden>
 

Index: addressbook.el
===================================================================
RCS file: /cvsroot/womb/addressbook/addressbook.el,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- addressbook.el      6 May 2007 18:06:39 -0000       1.5
+++ addressbook.el      6 May 2007 18:16:42 -0000       1.6
@@ -5,7 +5,7 @@
 ;; Maintainer: Jose E. Marchesi
 ;; Keywords: contacts, applications
 
-;; $Id: addressbook.el,v 1.5 2007/05/06 18:06:39 jemarch Exp $
+;; $Id: addressbook.el,v 1.6 2007/05/06 18:16:42 jemarch Exp $
 
 ;; This file is NOT part of GNU Emacs.
 
@@ -601,6 +601,24 @@
         ?c))
 
 (defun addrbook-set-custom-properties (props-data)
+"This function accepts a list of the form:
+
+  (PROP1 PROP2 ... PROPN)
+
+where each property PROP is defined with the following structure:
+
+  (\"property-name\" \"Property displayed name\"
+   ?character-identifying-the-group-for-fast-selection
+   (FIELD1 FIELD2 ... FIELDN)
+   (\"type\"
+      ((\"type1\" \"type1 displayed name\" ?fast-selection-char1)
+       (\"type2\" \"type 2 displayed name\" ?fast-selection-char2)
+       ...)
+    allow-several-types-p at-least-one-type-mandatory-p))
+
+where each field FIELD is defined with the following structure:
+
+  (\"Field name\" ?character-identifying-the-field-for-fast-selection)"
   (let (custom-group
         prop)
     (dolist (prop props-data)