[evolution-patches] ebook API docs

From: Ross Burton <ross burtonini com>
To: evolution-patches lists ximian com
Subject: [evolution-patches] ebook API docs
Date: Tue, 02 Dec 2003 22:50:59 +0000

Hi,

Attached is a start at documenting ebook -- I'm up to 34% documented so
far.  If someone could check  it over and make sure I'm not lying, that
would be great. :)

Ross
-- 
Ross Burton                                 mail: ross burtonini com
                                          jabber: ross burtonini com
                                     www: http://www.burtonini.com./
 PGP Fingerprint: 1A21 F5B0 D8D0 CFE3 81D4 E25A 2D09 E447 D0B4 33DF

Index: addressbook/libebook/e-book-listener.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-listener.c,v
retrieving revision 1.2
diff -u -r1.2 e-book-listener.c
--- addressbook/libebook/e-book-listener.c	11 Nov 2003 01:14:04 -0000	1.2
+++ addressbook/libebook/e-book-listener.c	2 Dec 2003 22:16:48 -0000
@@ -312,9 +312,8 @@
 
 /**
  * e_book_listener_new:
- * @book: the #EBook for which the listener is to be bound
  *
- * Creates and returns a new #EBookListener for the book.
+ * Creates and returns a new #EBookListener.
  *
  * Returns: a new #EBookListener
  */
Index: addressbook/libebook/e-book-listener.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-listener.h,v
retrieving revision 1.2
diff -u -r1.2 e-book-listener.h
--- addressbook/libebook/e-book-listener.h	4 Nov 2003 14:30:17 -0000	1.2
+++ addressbook/libebook/e-book-listener.h	2 Dec 2003 22:16:48 -0000
@@ -32,6 +32,7 @@
 
 struct _EBookListener {
 	BonoboObject           parent;
+	/*< private >*/
 	EBookListenerPrivate *priv;
 };
 
Index: addressbook/libebook/e-book-query.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-query.c,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 e-book-query.c
--- addressbook/libebook/e-book-query.c	3 Nov 2003 18:23:57 -0000	1.1.1.1
+++ addressbook/libebook/e-book-query.c	2 Dec 2003 22:16:48 -0000
@@ -65,12 +65,32 @@
 	return ret;
 }
 
+/**
+ * e_book_query_and:
+ * @nqs: the number of queries to AND
+ * @qs: pointer to an array of #EBookQuery items
+ * @unref:
+ *
+ * Create a new #EBookQuery which is the logical AND of the queries in #qs.
+ *
+ * Return value: A new #EBookQuery
+ */
 EBookQuery *
 e_book_query_and (int nqs, EBookQuery **qs, gboolean unref)
 {
 	return conjoin (E_BOOK_QUERY_TYPE_AND, nqs, qs, unref);
 }
 
+/**
+ * e_book_query_or:
+ * @nqs: the number of queries to OR
+ * @qs: pointer to an array of #EBookQuery items
+ * @unref: if #TRUE, the new query takes ownership of the existing queries
+ *
+ * Create a new #EBookQuery which is the logical OR of the queries in #qs.
+ *
+ * Return value: A new #EBookQuery
+ */
 EBookQuery *
 e_book_query_or (int nqs, EBookQuery **qs, gboolean unref)
 {
@@ -98,6 +118,15 @@
 	return ret;
 }
 
+/**
+ * e_book_query_andv:
+ * @q: first #EBookQuery
+ * @Varargs: #NULL terminated list of #EBookQuery pointers
+ *
+ * Create a new #EBookQuery which is the logical AND of the queries specified.
+ *
+ * Return value: A new #EBookQuery
+ */
 EBookQuery *
 e_book_query_andv (EBookQuery *q, ...)
 {
@@ -107,6 +136,15 @@
 	return conjoinv (E_BOOK_QUERY_TYPE_AND, q, ap);
 }
 
+/**
+ * e_book_query_orv:
+ * @q: first #EBookQuery
+ * @Varargs: #NULL terminated list of #EBookQuery pointers
+ *
+ * Create a new #EBookQuery which is the logical OR of the queries specified.
+ *
+ * Return value: A new #EBookQuery
+ */
 EBookQuery *
 e_book_query_orv (EBookQuery *q, ...)
 {
@@ -116,6 +154,15 @@
 	return conjoinv (E_BOOK_QUERY_TYPE_OR, q, ap);
 }
 
+/**
+ * e_book_query_not:
+ * @q: an #EBookQuery
+ * @unref: if #TRUE, the new query takes ownership of the existing queries
+ *
+ * Create a new #EBookQuery which is the opposite of #q.
+ *
+ * Return value: the new #EBookQuery
+ */
 EBookQuery *
 e_book_query_not (EBookQuery *q, gboolean unref)
 {
@@ -129,6 +176,16 @@
 	return ret;
 }
 
+/**
+ * e_book_query_field_test:
+ * @field: an #EContactField to test
+ * @test: the test to apply
+ * @value: the value to test for
+ *
+ * Create a new #EBookQuery which tests @field for @value using the test @test.
+ *
+ * Return value: the new #EBookQuery
+ */
 EBookQuery *
 e_book_query_field_test (EContactField field,
 			 EBookQueryTest test,
@@ -144,6 +201,13 @@
 	return ret;
 }
 
+/**
+ * e_book_query_field_exists:
+ * @field: a #EContactField
+ *
+ * Create a new #EBookQuery which tests if the field @field exists.
+ * Return value: the new #EBookQuery
+ */
 EBookQuery *
 e_book_query_field_exists (EContactField field)
 {
@@ -155,6 +219,14 @@
 	return ret;
 }
 
+/**
+ * e_book_query_any_field_contains:
+ * @value: a value
+ *
+ * Create a new #EBookQuery which tests if any field contains @value.
+ *
+ * Return value: the new #EBookQuery
+ */
 EBookQuery *
 e_book_query_any_field_contains (const char *value)
 {
@@ -166,6 +238,13 @@
 	return ret;
 }
 
+/**
+ * e_book_query_unref:
+ * @q: an #EBookQuery
+ *
+ * Decrement the reference count on @q. When the reference count reaches 0, @q
+ * will be freed and any child queries will have e_book_query_unref() called.
+ */
 void
 e_book_query_unref (EBookQuery *q)
 {
@@ -201,6 +280,12 @@
 	g_free (q);
 }
 
+/**
+ * e_book_query_ref:
+ * @q: a #EBookQuery
+ *
+ * Increment the reference count on @q.
+ */
 void
 e_book_query_ref (EBookQuery *q)
 {
@@ -413,6 +498,14 @@
 	{ "endswith", func_endswith, 0 },
 };
 
+/**
+ * e_book_query_from_string:
+ * @query_string: the query
+ *
+ * Parse @query_string and return a new #EBookQuery representing it.
+ *
+ * Return value: the new #EBookValue
+ */
 EBookQuery*
 e_book_query_from_string  (const char *query_string)
 {
@@ -461,6 +554,15 @@
 	return retval;
 }
 
+/**
+ * e_book_query_to_string:
+ * @q: an #EBookQuery
+ *
+ * Return the string representation of @q.
+ *
+ * Return value: The string form of the query. This string should be freed when
+ * finished with.
+ */
 char*
 e_book_query_to_string    (EBookQuery *q)
 {
Index: addressbook/libebook/e-book-query.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-query.h,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 e-book-query.h
--- addressbook/libebook/e-book-query.h	3 Nov 2003 18:23:57 -0000	1.1.1.1
+++ addressbook/libebook/e-book-query.h	2 Dec 2003 22:16:48 -0000
@@ -23,7 +23,7 @@
 #endif
 } EBookQueryTest;
 
-EBookQuery* e_book_query_from_string  (const char *sexp);
+EBookQuery* e_book_query_from_string  (const char *query_string);
 char*       e_book_query_to_string    (EBookQuery *q);
 
 void        e_book_query_ref          (EBookQuery *q);
@@ -34,7 +34,7 @@
 EBookQuery* e_book_query_or           (int nqs, EBookQuery **qs, gboolean unref);
 EBookQuery* e_book_query_orv          (EBookQuery *q, ...);
 
-EBookQuery* e_book_query_not          (EBookQuery *qs, gboolean unref);
+EBookQuery* e_book_query_not          (EBookQuery *q, gboolean unref);
 
 EBookQuery* e_book_query_field_exists (EContactField   field);
 EBookQuery* e_book_query_field_test   (EContactField   field,
Index: addressbook/libebook/e-book-view-listener.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-view-listener.c,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 e-book-view-listener.c
--- addressbook/libebook/e-book-view-listener.c	3 Nov 2003 18:23:57 -0000	1.1.1.1
+++ addressbook/libebook/e-book-view-listener.c	2 Dec 2003 22:16:48 -0000
@@ -231,9 +231,8 @@
 
 /**
  * e_book_view_listener_new:
- * @book: the #EBookView for which the listener is to be bound
  *
- * Creates and returns a new #EBookViewListener for the book.
+ * Creates and returns a new #EBookViewListener.
  *
  * Returns: a new #EBookViewListener
  */
Index: addressbook/libebook/e-book-view-listener.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-view-listener.h,v
retrieving revision 1.2
diff -u -r1.2 e-book-view-listener.h
--- addressbook/libebook/e-book-view-listener.h	4 Nov 2003 14:30:17 -0000	1.2
+++ addressbook/libebook/e-book-view-listener.h	2 Dec 2003 22:16:48 -0000
@@ -33,6 +33,7 @@
 
 struct _EBookViewListener {
 	BonoboObject           parent;
+	/*< private >*/
 	EBookViewListenerPrivate *priv;
 };
 
Index: addressbook/libebook/e-book-view.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-view.c,v
retrieving revision 1.2
diff -u -r1.2 e-book-view.c
--- addressbook/libebook/e-book-view.c	4 Nov 2003 14:30:17 -0000	1.2
+++ addressbook/libebook/e-book-view.c	2 Dec 2003 22:16:48 -0000
@@ -155,9 +155,6 @@
 	return TRUE;
 }
 
-/**
- * e_book_view_new:
- */
 EBookView *
 e_book_view_new (GNOME_Evolution_Addressbook_BookView corba_book_view, EBookViewListener *listener)
 {
Index: addressbook/libebook/e-book-view.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book-view.h,v
retrieving revision 1.2
diff -u -r1.2 e-book-view.h
--- addressbook/libebook/e-book-view.h	4 Nov 2003 14:30:17 -0000	1.2
+++ addressbook/libebook/e-book-view.h	2 Dec 2003 22:16:48 -0000
@@ -33,6 +33,7 @@
 
 struct _EBookView {
 	GObject     parent;
+	/*< private >*/
 	EBookViewPrivate *priv;
 };
 
Index: addressbook/libebook/e-book.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book.c,v
retrieving revision 1.8
diff -u -r1.8 e-book.c
--- addressbook/libebook/e-book.c	1 Dec 2003 15:18:31 -0000	1.8
+++ addressbook/libebook/e-book.c	2 Dec 2003 22:16:48 -0000
@@ -179,13 +179,14 @@
 
 
 /**
- * e_book_add_card:
+ * e_book_add_contact:
  * @book: an #EBook
  * @contact: an #EContact
+ * @error: a #GError to set on failure.
  *
  * adds @contact to @book.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise.
  **/
 gboolean
 e_book_add_contact (EBook           *book,
@@ -292,11 +293,12 @@
  * e_book_commit_contact:
  * @book: an #EBook
  * @contact: an #EContact
+ * @error: a #GError to set on failure
  *
  * applies the changes made to @contact to the stored version in
  * @book.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_commit_contact (EBook           *book,
@@ -375,11 +377,12 @@
  * e_book_get_supported_fields:
  * @book: an #EBook
  * @fields: a #GList
+ * @error: a #GError to set on failure
  *
- * queries @book for the list of fields it supports.  mostly for use
+ * Queries @book for the list of fields it supports. Mostly for use
  * by the contact editor so it knows what fields to sensitize.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_get_supported_fields  (EBook            *book,
@@ -475,10 +478,11 @@
  * e_book_get_supported_auth_methods:
  * @book: an #EBook
  * @auth_methods: a #GList
+ * @error: a #GError to set on failure
  *
- * queries @book for the list of authentication methods it supports.
+ * Queries @book for the list of authentication methods it supports.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_get_supported_auth_methods (EBook            *book,
@@ -578,12 +582,13 @@
  * @user: a string
  * @passwd: a string
  * @auth_method: a string
+ * @error: a #GError to set on failure
  *
- * authenticates @user with @passwd, using the auth method
+ * Authenticates @user with @passwd, using the auth method
  * @auth_method.  @auth_method must be one of the authentication
  * methods returned using e_book_get_supported_auth_methods.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_authenticate_user (EBook         *book,
@@ -662,11 +667,12 @@
  * @book: an #EBook
  * @id: a string
  * @contact: an #EContact
+ * @error: a #GError to set on failure
  *
  * Fills in @contact with the contents of the vcard in @book
  * corresponding to @id.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_get_contact (EBook       *book,
@@ -766,10 +772,11 @@
  * e_book_remove_contact:
  * @book: an #EBook
  * @id: a string
+ * @error: a #GError to set on failure
  *
  * Removes the contact with id @id from @book.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_remove_contact (EBook       *book,
@@ -811,13 +818,14 @@
  * e_book_remove_contacts:
  * @book: an #EBook
  * @ids: an #GList of const char *id's
+ * @error: a #GError to set on failure
  *
  * Removes the contacts with ids from the list @ids from @book.  This is
  * always more efficient than calling e_book_remove_contact_by_id if you
  * have more than one id to remove, as some backends can implement it
  * as a batch request.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_remove_contacts (EBook    *book,
@@ -900,12 +908,16 @@
  * e_book_get_book_view:
  * @book: an #EBook
  * @query: an #EBookQuery
- * @requested_fields a #GList containing the names of fields to return, or NULL for all
- * @max_results the maximum number of contacts to show (or 0 for all)
- *
- * need docs here..
+ * @requested_fields: a #GList containing the names of fields to return, or NULL for all
+ * @max_results: the maximum number of contacts to show (or 0 for all)
+ * @book_view: A #EBookView pointer, will be set to the view
+ * @error: a #GError to set on failure
+ *
+ * Query @book with @query, creating a #EBookView in @book_view with the fields
+ * specified by @requested_fields and limited at @max_results records. On an
+ * error, @error is set and #FALSE returned.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE if successful, #FALSE otherwise
  **/
 gboolean
 e_book_get_book_view (EBook       *book,
@@ -1036,10 +1048,13 @@
  * e_book_get_contacts:
  * @book: an #EBook
  * @query: an #EBookQuery
+ * @contacts: a #GList pointer, will be set to the list of contacts
+ * @error: a #GError to set on failure
  *
- * need docs here..
+ * Query @book with @query, setting @contacts to the list of contacts which
+ * matched. On failed, @error will be set and #FALSE returned.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE on success, #FALSE otherwise
  **/
 gboolean
 e_book_get_contacts (EBook       *book,
@@ -1274,6 +1289,7 @@
 /**
  * e_book_cancel:
  * @book: an #EBook
+ * @error: a #GError to set on failure
  *
  * Used to cancel an already running operation on @book.  This
  * function makes a synchronous CORBA to the backend telling it to
@@ -1285,7 +1301,7 @@
  * blocked e_book function corresponding to current operation will
  * return with a status of E_BOOK_STATUS_CANCELLED.
  *
- * Return value: a #EBookStatus value.
+ * Return value: #TRUE on success, #FALSE otherwise
  **/
 gboolean
 e_book_cancel (EBook   *book,
@@ -1368,6 +1384,16 @@
 
 
 
+/**
+ * e_book_remove:
+ * @book: an #EBook
+ * @error: a #GError to set on failure
+ *
+ * Remove the backing data for this #EBook. For example, with the file backend this
+ * deletes the database file. You cannot get it back!
+ *
+ * Return value: #TRUE on success, #FALSE on failure.
+ */
 gboolean
 e_book_remove (EBook   *book,
 	       GError **error)
@@ -1505,6 +1531,15 @@
 
 
 
+/**
+ * e_book_unload_uri:
+ * @book: an #EBook
+ * @error: an #GError to set on failure
+ *
+ * Unload the URI that this book had previously loaded.
+ *
+ * Return value: #TRUE on success, #FALSE otherwise.
+ */
 gboolean
 e_book_unload_uri (EBook   *book,
 		   GError **error)
@@ -1746,6 +1781,17 @@
 	return rv;
 }
 
+/**
+ * e_book_load_source:
+ * @book: an #EBook
+ * @source: the #ESource to load
+ * @only_if_exists: if #TRUE, fail if this source doesn't already exist otherwise create it first
+ * @error: a #GError to set on failure
+ *
+ * Load the specified source into the book.
+ *
+ * Return value: #TRUE if the source was loaded, #FALSE otherwise.
+ */
 gboolean
 e_book_load_source (EBook *book,
 		    ESource *source,
@@ -1761,6 +1807,17 @@
 	return fetch_corba_book (book, source, only_if_exists, error);
 }
 
+/**
+ * e_book_load_uri:
+ * @book: an #EBook
+ * @uri: the URI to load
+ * @only_if_exists: if #TRUE, fail if this URI doesn't already exist otherwise create it first
+ * @error: a #GError to set on failure
+ *
+ * Create an #ESource from #url and load the source. See e_book_load_source().
+ *
+ * Return value: #TRUE if the URI was loaded, #FALSE otherwise.
+ */
 gboolean
 e_book_load_uri (EBook        *book,
 		 const char   *uri,
@@ -1789,6 +1846,15 @@
 	return rv;
 }
 
+/**
+ * e_book_load_local_addressbook:
+ * @book: an #EBook
+ * @error: a #GError
+ *
+ * Load the local address book into #book.
+ *
+ * Return value: #TRUE on success, #FALSE otherwise.
+ */
 gboolean
 e_book_load_local_addressbook (EBook   *book,
 			       GError **error)
@@ -1811,12 +1877,30 @@
 	return rv;
 }
 
+/**
+ * e_book_get_uri:
+ * @book: an #EBook
+ *
+ * Get the URI that this book has loaded. This string should not be freed.
+ *
+ * Return value: The URI.
+ */
 const char *
 e_book_get_uri (EBook *book)
 {
 	return book->priv->uri;
 }
 
+/**
+ * e_book_get_static_capabilities:
+ * @book: an #EBook
+ * @error: an #GError to set on failure
+ *
+ * Get the list of capabilities which the backend for this address book
+ * supports. This string should not be freed.
+ *
+ * Return value: The capabilities list
+ */
 const char *
 e_book_get_static_capabilities (EBook   *book,
 				GError **error)
@@ -1852,6 +1936,16 @@
 	return book->priv->cap;
 }
 
+/**
+ * e_book_check_static_capability:
+ * @book: an #EBook
+ * @cap: A capability string
+ *
+ * Check to see if the backend for this address book supports the capability
+ * @cap.
+ *
+ * Return value: #TRUE if the backend supports @cap, #FALSE otherwise.
+ */
 gboolean
 e_book_check_static_capability (EBook *book,
 				const char  *cap)
@@ -1865,6 +1959,14 @@
 	return FALSE;
 }
 
+/**
+ * e_book_is_writable:
+ * @book: an #EBook
+ * 
+ * Check if this book is writable.
+ * 
+ * Return value: #TRUE if this book is writable, otherwise #FALSE.
+ */
 gboolean
 e_book_is_writable (EBook *book)
 {
@@ -1942,6 +2044,16 @@
 
 
 
+/**
+ * e_book_get_default_addressbook:
+ * @book: The address of a pointer to an #EBook
+ * @error: A #GError pointer
+ * 
+ * Convience function to open the default address book. Pass it the address of a
+ * #EBook* and if this returns #TRUE, #book is set to an opened #EBook.
+ * 
+ * Return value: #TRUE if the default addressbook was opened, otherwise #FALSE.
+ */
 gboolean
 e_book_get_default_addressbook (EBook **book, GError **error)
 {
@@ -1971,6 +2089,16 @@
 	return rv;
 }
 
+/**
+ * e_book_get_addressbooks:
+ * @addressbook_sources: A pointer to a ESourceList* to set
+ * @error: A pointer to a GError* to set on error
+ *
+ * Populate *addressbook_sources with the list of all sources which have been
+ * added to Evolution.
+ *
+ * Return value: #TRUE if @addressbook_sources was set, otherwise #FALSE.
+ */
 gboolean
 e_book_get_addressbooks (ESourceList **addressbook_sources, GError **error)
 {
@@ -2008,6 +2136,15 @@
 
 
 
+/**
+ * e_book_new:
+ *
+ * Creates a new #EBook. Use e_book_load_uri() or
+ * e_book_load_local_addressbook() to access a data store.  Alternatively use
+ * e_book_get_default_addressbook().
+ *
+ * Return value: a new but unopened #EBook.
+ **/
 EBook*
 e_book_new (void)
 {
Index: addressbook/libebook/e-book.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-book.h,v
retrieving revision 1.4
diff -u -r1.4 e-book.h
--- addressbook/libebook/e-book.h	27 Nov 2003 02:29:02 -0000	1.4
+++ addressbook/libebook/e-book.h	2 Dec 2003 22:16:48 -0000
@@ -37,6 +37,7 @@
 
 struct _EBook {
 	GObject       parent;
+	/*< private >*/
 	EBookPrivate *priv;
 };
 
@@ -108,7 +109,7 @@
 					    GError     **error);
 
 gboolean e_book_remove_contacts            (EBook       *book,
-					    GList       *id_list,
+					    GList       *ids,
 					    GError     **error);
 
 /* Adding contacts. */
Index: addressbook/libebook/e-contact.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-contact.h,v
retrieving revision 1.3
diff -u -r1.3 e-contact.h
--- addressbook/libebook/e-contact.h	26 Nov 2003 00:35:30 -0000	1.3
+++ addressbook/libebook/e-contact.h	2 Dec 2003 22:16:48 -0000
@@ -180,7 +180,7 @@
 
 struct _EContact {
 	EVCard parent;
-
+	/*< private >*/
 	EContactPrivate *priv;
 };
 
Index: addressbook/libebook/e-name-western.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-name-western.c,v
retrieving revision 1.1
diff -u -r1.1 e-name-western.c
--- addressbook/libebook/e-name-western.c	7 Nov 2003 21:45:48 -0000	1.1
+++ addressbook/libebook/e-name-western.c	2 Dec 2003 22:16:49 -0000
@@ -961,9 +961,9 @@
 
 /**
  * e_name_western_free:
- * @name: An ENameWestern object which needs to be freed.
+ * @w: An ENameWestern object which needs to be freed.
  *
- * Deep-frees @name
+ * Deep-frees @w
  */
 void
 e_name_western_free (ENameWestern *w)
Index: addressbook/libebook/e-vcard.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/addressbook/libebook/e-vcard.h,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 e-vcard.h
--- addressbook/libebook/e-vcard.h	3 Nov 2003 18:23:57 -0000	1.1.1.1
+++ addressbook/libebook/e-vcard.h	2 Dec 2003 22:16:49 -0000
@@ -92,7 +92,7 @@
 
 struct _EVCard {
 	GObject parent;
-
+	/*< private >*/
 	EVCardPrivate *priv;
 };
 
Index: docs/reference/addressbook/libebook/libebook-docs.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/libebook-docs.sgml,v
retrieving revision 1.2
diff -u -r1.2 libebook-docs.sgml
--- docs/reference/addressbook/libebook/libebook-docs.sgml	25 Nov 2003 17:52:24 -0000	1.2
+++ docs/reference/addressbook/libebook/libebook-docs.sgml	2 Dec 2003 22:16:49 -0000
@@ -3,19 +3,19 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
 <book id="index" xmlns:xi="http://www.w3.org/2001/XInclude";>
   <bookinfo>
-<title>Evolution API Reference: libebook, the Addressbook Library</title>
+    <title>Evolution Addressbook Library</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libebook, the Addressbook Library</title>
-    <xi:include href="xml/e-book-listener.xml"/>
-    <xi:include href="xml/e-book-view-listener.xml"/>
-    <xi:include href="xml/e-book-view.xml"/>
+    <title>libebook</title>
     <xi:include href="xml/e-book.xml"/>
+    <xi:include href="xml/e-book-query.xml"/>
     <xi:include href="xml/e-contact.xml"/>
     <xi:include href="xml/e-vcard.xml"/>
+    <xi:include href="xml/e-book-listener.xml"/>
+    <xi:include href="xml/e-book-view.xml"/>
+    <xi:include href="xml/e-book-view-listener.xml"/>
     <xi:include href="xml/e-book-async.xml"/>
-    <xi:include href="xml/e-book-query.xml"/>
     <xi:include href="xml/e-book-types.xml"/>
     <xi:include href="xml/e-address-western.xml"/>
     <xi:include href="xml/e-name-western.xml"/>
Index: docs/reference/addressbook/libebook/libebook-sections.txt
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/libebook-sections.txt,v
retrieving revision 1.2
diff -u -r1.2 libebook-sections.txt
--- docs/reference/addressbook/libebook/libebook-sections.txt	20 Nov 2003 21:29:01 -0000	1.2
+++ docs/reference/addressbook/libebook/libebook-sections.txt	2 Dec 2003 22:16:49 -0000
@@ -1,11 +1,13 @@
 <SECTION>
 <FILE>e-book-listener</FILE>
-EBookListenerResponse
 <TITLE>EBookListener</TITLE>
+EBookListener
+EBookListenerResponse
 EBookListenerOperation
 e_book_listener_new
 e_book_listener_stop
 <SUBSECTION Standard>
+EBookListenerClass
 E_BOOK_LISTENER
 E_IS_BOOK_LISTENER
 E_TYPE_BOOK_LISTENER
@@ -19,12 +21,14 @@
 
 <SECTION>
 <FILE>e-book-view-listener</FILE>
-EBookViewListenerResponse
 <TITLE>EBookViewListener</TITLE>
+EBookViewListener
+EBookViewListenerResponse
 EBookViewListenerOperation
 e_book_view_listener_new
 e_book_view_listener_stop
 <SUBSECTION Standard>
+EBookViewListenerClass
 E_BOOK_VIEW_LISTENER
 E_IS_BOOK_VIEW_LISTENER
 E_TYPE_BOOK_VIEW_LISTENER
@@ -39,11 +43,13 @@
 <SECTION>
 <FILE>e-book-view</FILE>
 <TITLE>EBookView</TITLE>
+EBookView
 e_book_view_new
 e_book_view_set_book
 e_book_view_start
 e_book_view_stop
 <SUBSECTION Standard>
+EBookViewClass
 E_BOOK_VIEW
 E_IS_BOOK_VIEW
 E_TYPE_BOOK_VIEW
@@ -58,7 +64,9 @@
 <SECTION>
 <FILE>e-book</FILE>
 <TITLE>EBook</TITLE>
+EBook
 e_book_new
+e_book_load_source
 e_book_load_uri
 e_book_unload_uri
 e_book_remove
@@ -82,9 +90,11 @@
 e_book_cancel
 e_book_get_self
 e_book_set_self
+e_book_is_self
 e_book_get_default_addressbook
 e_book_get_addressbooks
 <SUBSECTION Standard>
+EBookClass
 E_BOOK
 E_IS_BOOK
 E_TYPE_BOOK
@@ -98,12 +108,13 @@
 
 <SECTION>
 <FILE>e-contact</FILE>
+<TITLE>EContact</TITLE>
+EContact
 EContactField
 EContactName
 EContactPhoto
 EContactAddress
 EContactDate
-<TITLE>EContact</TITLE>
 e_contact_new
 e_contact_new_from_vcard
 e_contact_duplicate
@@ -113,6 +124,7 @@
 e_contact_date_new
 e_contact_date_from_string
 e_contact_date_to_string
+e_contact_date_equal
 e_contact_name_new
 e_contact_name_to_string
 e_contact_name_from_string
@@ -125,19 +137,65 @@
 e_contact_pretty_name
 e_contact_field_id
 <SUBSECTION Standard>
+EContactClass
 E_CONTACT
 E_IS_CONTACT
 E_TYPE_CONTACT
-e_contact_get_type
 E_CONTACT_CLASS
 E_IS_CONTACT_CLASS
 E_CONTACT_GET_CLASS
+e_contact_get_type
+e_contact_address_get_type
+e_contact_photo_get_type
+e_contact_name_get_type
+e_contact_date_get_type
+
 <SUBSECTION Private>
 EContactPrivate
 </SECTION>
 
 <SECTION>
 <FILE>e-vcard</FILE>
+<TITLE>EVCard</TITLE>
+EVCard
+EVCardFormat
+EVCardAttribute
+EVCardAttributeParam
+e_vcard_construct
+e_vcard_new
+e_vcard_new_from_string
+e_vcard_to_string
+e_vcard_dump_structure
+e_vcard_attribute_new
+e_vcard_attribute_free
+e_vcard_attribute_copy
+e_vcard_remove_attributes
+e_vcard_remove_attribute
+e_vcard_add_attribute
+e_vcard_add_attribute_with_value
+e_vcard_add_attribute_with_values
+e_vcard_attribute_add_value
+e_vcard_attribute_add_value_decoded
+e_vcard_attribute_add_values
+e_vcard_attribute_remove_values
+e_vcard_attribute_remove_params
+e_vcard_attribute_param_new
+e_vcard_attribute_param_free
+e_vcard_attribute_param_copy
+e_vcard_attribute_add_param
+e_vcard_attribute_add_param_with_value
+e_vcard_attribute_add_param_with_values
+e_vcard_attribute_param_add_value
+e_vcard_attribute_param_add_values
+e_vcard_attribute_param_remove_values
+e_vcard_get_attributes
+e_vcard_attribute_get_group
+e_vcard_attribute_get_name
+e_vcard_attribute_get_values
+e_vcard_attribute_get_values_decoded
+e_vcard_attribute_get_params
+e_vcard_attribute_param_get_name
+e_vcard_attribute_param_get_values
 EVC_ADR
 EVC_BDAY
 EVC_CALURI
@@ -181,46 +239,8 @@
 EVC_X_SPOUSE
 EVC_X_WANTS_HTML
 EVC_X_YAHOO
-EVCardFormat
-EVCardAttribute
-EVCardAttributeParam
-<TITLE>EVCard</TITLE>
-e_vcard_construct
-e_vcard_new
-e_vcard_new_from_string
-e_vcard_to_string
-e_vcard_dump_structure
-e_vcard_attribute_new
-e_vcard_attribute_free
-e_vcard_attribute_copy
-e_vcard_remove_attributes
-e_vcard_remove_attribute
-e_vcard_add_attribute
-e_vcard_add_attribute_with_value
-e_vcard_add_attribute_with_values
-e_vcard_attribute_add_value
-e_vcard_attribute_add_value_decoded
-e_vcard_attribute_add_values
-e_vcard_attribute_remove_values
-e_vcard_attribute_remove_params
-e_vcard_attribute_param_new
-e_vcard_attribute_param_free
-e_vcard_attribute_param_copy
-e_vcard_attribute_add_param
-e_vcard_attribute_add_param_with_value
-e_vcard_attribute_add_param_with_values
-e_vcard_attribute_param_add_value
-e_vcard_attribute_param_add_values
-e_vcard_attribute_param_remove_values
-e_vcard_get_attributes
-e_vcard_attribute_get_group
-e_vcard_attribute_get_name
-e_vcard_attribute_get_values
-e_vcard_attribute_get_values_decoded
-e_vcard_attribute_get_params
-e_vcard_attribute_param_get_name
-e_vcard_attribute_param_get_values
 <SUBSECTION Standard>
+EVCardClass
 E_VCARD
 E_IS_VCARD
 E_TYPE_VCARD
@@ -242,6 +262,7 @@
 EBookBookViewCallback
 EBookFieldsCallback
 EBookAuthMethodsCallback
+e_book_async_load_source
 e_book_async_load_uri
 e_book_async_get_default_addressbook
 e_book_async_unload_uri
@@ -260,6 +281,7 @@
 
 <SECTION>
 <FILE>e-book-query</FILE>
+EBookQuery
 EBookQueryTest
 e_book_query_from_string
 e_book_query_to_string
@@ -287,6 +309,7 @@
 
 <SECTION>
 <FILE>e-address-western</FILE>
+<TITLE>EAddressWestern</TITLE>
 EAddressWestern
 e_address_western_parse
 e_address_western_free
@@ -298,6 +321,7 @@
 
 <SECTION>
 <FILE>e-name-western</FILE>
+<TITLE>ENameWestern</TITLE>
 ENameWestern
 e_name_western_parse
 e_name_western_free
Index: docs/reference/addressbook/libebook/libebook.types
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/libebook.types,v
retrieving revision 1.1
diff -u -r1.1 libebook.types
--- docs/reference/addressbook/libebook/libebook.types	10 Nov 2003 19:34:47 -0000	1.1
+++ docs/reference/addressbook/libebook/libebook.types	2 Dec 2003 22:16:49 -0000
@@ -4,4 +4,4 @@
 e_book_view_get_type
 e_book_get_type
 e_contact_get_type
-e_vcard_get_type
\ No newline at end of file
+e_vcard_get_type
Index: docs/reference/addressbook/libebook/tmpl/e-book-async.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book-async.sgml,v
retrieving revision 1.3
diff -u -r1.3 e-book-async.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book-async.sgml	25 Nov 2003 17:52:24 -0000	1.3
+++ docs/reference/addressbook/libebook/tmpl/e-book-async.sgml	2 Dec 2003 22:16:49 -0000
@@ -102,6 +102,17 @@
 @closure: 
 
 
+<!-- ##### FUNCTION e_book_async_load_source ##### -->
+<para>
+
+</para>
+
+ book: 
+ source: 
+ open_response: 
+ closure: 
+
+
 <!-- ##### FUNCTION e_book_async_load_uri ##### -->
 <para>
 
Index: docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml,v
retrieving revision 1.2
diff -u -r1.2 e-book-listener.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml	25 Nov 2003 17:52:25 -0000	1.2
+++ docs/reference/addressbook/libebook/tmpl/e-book-listener.sgml	2 Dec 2003 22:16:49 -0000
@@ -2,7 +2,7 @@
 EBookListener
 
 <!-- ##### SECTION Short_Description ##### -->
-Listens for call responses and event notifications from EBook objects. 
+Listens for call responses and event notifications from EBook objects.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -15,7 +15,7 @@
 
 </para>
 
-<!-- ##### STRUCT EBookListenerPrivate ##### -->
+<!-- ##### STRUCT EBookListener ##### -->
 <para>
 
 </para>
Index: docs/reference/addressbook/libebook/tmpl/e-book-query.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book-query.sgml,v
retrieving revision 1.2
diff -u -r1.2 e-book-query.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book-query.sgml	20 Nov 2003 21:29:01 -0000	1.2
+++ docs/reference/addressbook/libebook/tmpl/e-book-query.sgml	2 Dec 2003 22:16:49 -0000
@@ -19,10 +19,10 @@
 
 </para>
 
- E_BOOK_QUERY_IS: 
- E_BOOK_QUERY_CONTAINS: 
- E_BOOK_QUERY_BEGINS_WITH: 
- E_BOOK_QUERY_ENDS_WITH: 
+ E_BOOK_QUERY_IS: The field matches the test value
+ E_BOOK_QUERY_CONTAINS: The field contains the test value
+ E_BOOK_QUERY_BEGINS_WITH: The field begins with the test value
+ E_BOOK_QUERY_ENDS_WITH: The field ends with the test value
 @E_BOOK_QUERY_LE: 
 @E_BOOK_QUERY_GT: 
 @E_BOOK_QUERY_GE: 
@@ -33,8 +33,10 @@
 
 </para>
 
- sexp: 
+ query_string: 
 @Returns: 
+<!-- # Unused Parameters # -->
+ sexp: 
 
 
 <!-- ##### FUNCTION e_book_query_to_string ##### -->
@@ -109,9 +111,11 @@
 
 </para>
 
- qs: 
+ q: 
 @unref: 
 @Returns: 
+<!-- # Unused Parameters # -->
+ qs: 
 
 
 <!-- ##### FUNCTION e_book_query_field_exists ##### -->
Index: docs/reference/addressbook/libebook/tmpl/e-book-types.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book-types.sgml,v
retrieving revision 1.2
diff -u -r1.2 e-book-types.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book-types.sgml	20 Nov 2003 21:29:01 -0000	1.2
+++ docs/reference/addressbook/libebook/tmpl/e-book-types.sgml	2 Dec 2003 22:16:49 -0000
@@ -4,7 +4,7 @@
 <!-- ##### SECTION Short_Description ##### -->
 
 Client-side GOBject which exposes the
-Evolution:BookListener interface. 
+Evolution:BookListener interface.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -41,6 +41,7 @@
 @E_BOOK_ERROR_BUSY: 
 @E_BOOK_ERROR_REPOSITORY_OFFLINE: 
 @E_BOOK_ERROR_NO_SUCH_BOOK: 
+ E_BOOK_ERROR_NO_SELF_CONTACT: 
 @E_BOOK_ERROR_URI_NOT_LOADED: 
 @E_BOOK_ERROR_URI_ALREADY_LOADED: 
 @E_BOOK_ERROR_PERMISSION_DENIED: 
Index: docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml,v
retrieving revision 1.3
diff -u -r1.3 e-book-view-listener.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml	25 Nov 2003 17:52:25 -0000	1.3
+++ docs/reference/addressbook/libebook/tmpl/e-book-view-listener.sgml	2 Dec 2003 22:16:49 -0000
@@ -15,7 +15,7 @@
 EBookTypes
 </para>
 
-<!-- ##### STRUCT EBookViewListenerPrivate ##### -->
+<!-- ##### STRUCT EBookViewListener ##### -->
 <para>
 
 </para>
@@ -45,7 +45,7 @@
 
 <!-- ##### FUNCTION e_book_view_listener_new ##### -->
 <para>
-Creation function.
+
 </para>
 
 @Returns: 
Index: docs/reference/addressbook/libebook/tmpl/e-book.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-book.sgml,v
retrieving revision 1.3
diff -u -r1.3 e-book.sgml
--- docs/reference/addressbook/libebook/tmpl/e-book.sgml	25 Nov 2003 17:52:25 -0000	1.3
+++ docs/reference/addressbook/libebook/tmpl/e-book.sgml	2 Dec 2003 22:16:49 -0000
@@ -29,6 +28,18 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_book_load_source ##### -->
+<para>
+
+</para>
+
+ book: 
+ source: 
+ only_if_exists: 
+ error: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_book_load_uri ##### -->
 <para>
 
@@ -135,7 +146,7 @@
 </para>
 
 @book: 
- id_list: 
+ ids: 
 @error: 
 @Returns: 
 
@@ -258,7 +269,7 @@
 
 <!-- ##### FUNCTION e_book_get_self ##### -->
 <para>
-Gets the address information for the current Evolution user.
+
 </para>
 
 @contact: 
@@ -273,11 +284,20 @@
 </para>
 
 @book: 
- id: 
+ contact: 
 @error: 
 @Returns: 
 
 
+<!-- ##### FUNCTION e_book_is_self ##### -->
+<para>
+
+</para>
+
+ contact: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_book_get_default_addressbook ##### -->
 <para>
 
@@ -300,7 +320,7 @@
 
 <!-- ##### SIGNAL EBook::backend-died ##### -->
 <para>
-
+The backend for this address book has died.
 </para>
 
 @ebook: the object which received the signal.
Index: docs/reference/addressbook/libebook/tmpl/e-contact.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/addressbook/libebook/tmpl/e-contact.sgml,v
retrieving revision 1.2
diff -u -r1.2 e-contact.sgml
--- docs/reference/addressbook/libebook/tmpl/e-contact.sgml	25 Nov 2003 17:52:25 -0000	1.2
+++ docs/reference/addressbook/libebook/tmpl/e-contact.sgml	2 Dec 2003 22:16:49 -0000
@@ -14,7 +14,7 @@
 #e-vcard
 </para>
 
-<!-- ##### STRUCT EContactPrivate ##### -->
+<!-- ##### STRUCT EContact ##### -->
 <para>
 
 </para>
@@ -210,6 +210,16 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_contact_date_equal ##### -->
+<para>
+
+</para>
+
+ dt1: 
+ dt2: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_contact_name_new ##### -->
 <para>

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