[evolution-data-server/documentation-effort: 14/18] Addressbook: Fixing up gtk-doc comments, ensuring main descriptions.



commit 989a213e1133f4616ee2dd2b9483a9e06b6ea537
Author: Tristan Van Berkom <tristan upstairslabs com>
Date:   Thu Dec 5 20:29:36 2013 +0900

    Addressbook: Fixing up gtk-doc comments, ensuring main descriptions.

 addressbook/libebook-contacts/e-book-query.c |   10 ++++++++++
 addressbook/libebook-contacts/e-contact.c    |   10 ++++++++++
 addressbook/libebook-contacts/e-vcard.c      |    2 +-
 addressbook/libebook/e-book-client-view.c    |   10 ++++++++++
 addressbook/libebook/e-book-client.c         |    9 +++++++++
 5 files changed, 40 insertions(+), 1 deletions(-)
---
diff --git a/addressbook/libebook-contacts/e-book-query.c b/addressbook/libebook-contacts/e-book-query.c
index d6180e3..8bbb49e 100644
--- a/addressbook/libebook-contacts/e-book-query.c
+++ b/addressbook/libebook-contacts/e-book-query.c
@@ -24,6 +24,16 @@
  *    Tristan Van Berkom <tristanvb openismus com>
  */
 
+/**
+ * SECTION: e-book-query
+ * @include: libebook-contacts/libebook-contacts.h
+ * @short_description: Querying and filtering contacts in an addressbook
+ *
+ * This utility can be used to conveniently create search expressions
+ * which can later be used to query and filter results in the #EBookClient,
+ * #EBookClientView and #EBookClientCursor interfaces.
+ **/
+
 #include "e-book-query.h"
 
 #include <config.h>
diff --git a/addressbook/libebook-contacts/e-contact.c b/addressbook/libebook-contacts/e-contact.c
index 89d9966..1638de3 100644
--- a/addressbook/libebook-contacts/e-contact.c
+++ b/addressbook/libebook-contacts/e-contact.c
@@ -23,6 +23,16 @@
  *   Tristan Van Berkom <tristanvb openismus com>
  */
 
+/**
+ * SECTION:e-contact
+ * @short_description: A convenience interface for interacting with contacts
+ * @include: libebook-contacts/libebook-contacts.h
+ *
+ * This subclass of #EVCard is a convenient interface for interacting with
+ * vCards. The #EBookClient, #EBookClientView and #EBookClientCursor return
+ * vCards in the form of an #EContact for your convenience.
+ **/
+
 #if HAVE_CONFIG_H
 #include <config.h>
 #endif
diff --git a/addressbook/libebook-contacts/e-vcard.c b/addressbook/libebook-contacts/e-vcard.c
index 8e3c134..f1e37d8 100644
--- a/addressbook/libebook-contacts/e-vcard.c
+++ b/addressbook/libebook-contacts/e-vcard.c
@@ -26,7 +26,7 @@
  * SECTION:e-vcard
  * @short_description: vCard parsing and interpretation
  * @stability: Stable
- * @include: libebook-contacts/e-vcard.h
+ * @include: libebook-contacts/libebook-contacts.h
  *
  * #EVCard is a low-level representation of a vCard, as specified in RFCs
  * 2425 and 2426 (for vCard version 3.0); this class only supports versions 2.1
diff --git a/addressbook/libebook/e-book-client-view.c b/addressbook/libebook/e-book-client-view.c
index ce85774..7569d12 100644
--- a/addressbook/libebook/e-book-client-view.c
+++ b/addressbook/libebook/e-book-client-view.c
@@ -20,6 +20,16 @@
  * Author: Ross Burton <ross linux intel com>
  */
 
+/**
+ * SECTION: e-book-client-view
+ * @include: libebook/libebook.h
+ * @short_description: Recieving change notifications on addressbooks 
+ *
+ * This class provides functionality for watching for changes on a
+ * given addressbook opened with an #EBookClient. Use e_book_client_get_view()
+ * to create an #EBookClientView.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
diff --git a/addressbook/libebook/e-book-client.c b/addressbook/libebook/e-book-client.c
index abb78e4..8ab9698 100644
--- a/addressbook/libebook/e-book-client.c
+++ b/addressbook/libebook/e-book-client.c
@@ -20,6 +20,15 @@
  *
  */
 
+/**
+ * SECTION: e-book-client
+ * @include: libebook/libebook.h
+ * @short_description: Accessing and modifying an addressbook 
+ *
+ * This class is the main user facing API for accessing and modifying
+ * the addressbook.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif


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