[evolution-data-server/openismus-work-3-8: 108/116] EBookClientCursor: Enhancing API documentation.

[Tristan Van Berkom <tvb src gnome org>]

commit d3287fb93481d6208b10298df8ae56b7ee3d83ee
Author: Tristan Van Berkom <tristanvb openismus com>
Date:   Fri Aug 30 14:25:25 2013 +0200

    EBookClientCursor: Enhancing API documentation.
    
    Added a link to EBookClientCursor to include the cursor-example.c
    sources directly in the cursor documentation.

 addressbook/libebook/e-book-client-cursor.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
---
diff --git a/addressbook/libebook/e-book-client-cursor.c b/addressbook/libebook/e-book-client-cursor.c
index 2d12b5d..0c8fcf2 100644
--- a/addressbook/libebook/e-book-client-cursor.c
+++ b/addressbook/libebook/e-book-client-cursor.c
@@ -197,6 +197,17 @@
  * you have reached in the active alphabet.
  * </para>
  * </refsect2>
+ *
+ * <refsect2 id="cursor-example">
+ * <title>Example contact browser</title>
+ * <para>
+ * EDS includes a fully functional example contact browser as an
+ * example of how to use the cursor API. The most relevant part of
+ * this example program is listed below.
+ *
+ * <example id="example-contact-browser"><title>Example Contact Browser</title><programlisting><xi:include 
xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" 
href="../../../../../tests/cursor-example/cursor-example.c"><xi:fallback>FIXME: MISSING XINCLUDE 
CONTENT</xi:fallback></xi:include></programlisting></example>
+ * </para>
+ * </refsect2>
  */
 #ifdef HAVE_CONFIG_H
 #include <config.h>