GNOME.org
 

evolution-data-server r9705 - in trunk/docs/reference: addressbook/libebook addressbook/libebook/tmpl addressbook/libedata-book addressbook/libedata-book/tmpl calendar/libecal calendar/libedata-cal calendar/libedata-cal/tmpl libebackend libedataserver libedataserverui libedataserverui/tmpl

Author: mbarnes
Date: Fri Oct 24 11:57:23 2008
New Revision: 9705
URL: http://svn.gnome.org/viewvc/evolution-data-server?rev=9705&view=rev

Log:
API documentation updates.


Added:
   trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-loader-factory.sgml
Modified:
   trunk/docs/reference/addressbook/libebook/libebook-docs.sgml
   trunk/docs/reference/addressbook/libebook/libebook-sections.txt
   trunk/docs/reference/addressbook/libebook/tmpl/e-book.sgml
   trunk/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
   trunk/docs/reference/addressbook/libedata-book/libedata-book-sections.txt
   trunk/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml
   trunk/docs/reference/calendar/libecal/libecal-docs.sgml
   trunk/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
   trunk/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
   trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend.sgml
   trunk/docs/reference/libebackend/libebackend-docs.xml
   trunk/docs/reference/libedataserver/libedataserver-docs.sgml
   trunk/docs/reference/libedataserver/libedataserver-sections.txt
   trunk/docs/reference/libedataserverui/libedataserverui-docs.sgml
   trunk/docs/reference/libedataserverui/libedataserverui-sections.txt
   trunk/docs/reference/libedataserverui/tmpl/e-name-selector-entry.sgml

Modified: trunk/docs/reference/addressbook/libebook/libebook-docs.sgml
==============================================================================
--- trunk/docs/reference/addressbook/libebook/libebook-docs.sgml	(original)
+++ trunk/docs/reference/addressbook/libebook/libebook-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "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-Data-Server Manual: Address Book Client (libebook)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libebook, the Addressbook Library</title>
+    <title>Evolution-Data-Server Manual: Address Book Client (libebook)</title>
     <xi:include href="xml/e-book.xml"/>
     <xi:include href="xml/e-book-listener.xml"/>
     <xi:include href="xml/e-book-query.xml"/>

Modified: trunk/docs/reference/addressbook/libebook/libebook-sections.txt
==============================================================================
--- trunk/docs/reference/addressbook/libebook/libebook-sections.txt	(original)
+++ trunk/docs/reference/addressbook/libebook/libebook-sections.txt	Fri Oct 24 11:57:23 2008
@@ -96,6 +96,7 @@
 e_book_check_static_capability
 e_book_is_writable
 e_book_cancel
+e_book_cancel_async_op
 e_book_get_self
 e_book_set_self
 e_book_is_self

Modified: trunk/docs/reference/addressbook/libebook/tmpl/e-book.sgml
==============================================================================
--- trunk/docs/reference/addressbook/libebook/tmpl/e-book.sgml	(original)
+++ trunk/docs/reference/addressbook/libebook/tmpl/e-book.sgml	Fri Oct 24 11:57:23 2008
@@ -357,6 +357,16 @@
 @Returns: 
 
 
+<!-- ##### FUNCTION e_book_cancel_async_op ##### -->
+<para>
+
+</para>
+
+ book: 
+ error: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_book_get_self ##### -->
 <para>
 

Modified: trunk/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
==============================================================================
--- trunk/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml	(original)
+++ trunk/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
-    <title>Evolution API Reference: libedata-book, the Addressbook backend library</title>
+    <title>Evolution-Data-Server Manual: Address Book Backend (libedata-book)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libedata-book, the Addressbook backend library</title>
+    <title>Evolution-Data-Server Manual: Address Book Backend (libedata-book)</title>
     <xi:include href="xml/e-book-backend.xml"/>
     <xi:include href="xml/e-book-backend-cache.xml"/>
     <xi:include href="xml/e-book-backend-db-cache.xml"/>

Modified: trunk/docs/reference/addressbook/libedata-book/libedata-book-sections.txt
==============================================================================
--- trunk/docs/reference/addressbook/libedata-book/libedata-book-sections.txt	(original)
+++ trunk/docs/reference/addressbook/libedata-book/libedata-book-sections.txt	Fri Oct 24 11:57:23 2008
@@ -262,6 +262,8 @@
 e_data_book_view_notify_remove
 e_data_book_view_notify_complete
 e_data_book_view_notify_status_message
+e_data_book_view_ref
+e_data_book_view_unref
 <SUBSECTION Standard>
 E_DATA_BOOK_VIEW
 E_IS_DATA_BOOK_VIEW

Modified: trunk/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml
==============================================================================
--- trunk/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml	(original)
+++ trunk/docs/reference/addressbook/libedata-book/tmpl/e-data-book-view.sgml	Fri Oct 24 11:57:23 2008
@@ -155,3 +155,19 @@
 @message: 
 
 
+<!-- ##### FUNCTION e_data_book_view_ref ##### -->
+<para>
+
+</para>
+
+ book_view: 
+
+
+<!-- ##### FUNCTION e_data_book_view_unref ##### -->
+<para>
+
+</para>
+
+ book_view: 
+
+

Modified: trunk/docs/reference/calendar/libecal/libecal-docs.sgml
==============================================================================
--- trunk/docs/reference/calendar/libecal/libecal-docs.sgml	(original)
+++ trunk/docs/reference/calendar/libecal/libecal-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "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: libecal, the Calendar Library</title>
+    <title>Evolution-Data-Server Manual: Calendar Client (libecal)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libecal, the Calendar Library</title>
+    <title>Evolution-Data-Server Manual: Calendar Client (libecal)</title>
     <xi:include href="xml/e-cal.xml"/>
     <xi:include href="xml/e-cal-component.xml"/>
     <xi:include href="xml/e-cal-listener.xml"/>

Modified: trunk/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
==============================================================================
--- trunk/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml	(original)
+++ trunk/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "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: libedata-cal, the Calendar Backend Library</title>
+    <title>Evolution-Data-Server Manual: Calendar Backend (libedata-cal)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libedata-cal, the Calendar Backend Library</title>
+    <title>Evolution-Data-Server Manual: Calendar Backend (libedata-cal)</title>
     <xi:include href="xml/e-cal-backend.xml"/>
     <xi:include href="xml/e-cal-backend-cache.xml"/>
     <xi:include href="xml/e-cal-backend-factory.xml"/>

Modified: trunk/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
==============================================================================
--- trunk/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt	(original)
+++ trunk/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt	Fri Oct 24 11:57:23 2008
@@ -172,6 +172,9 @@
 e_cal_backend_notify_view_progress
 e_cal_backend_notify_readonly
 e_cal_backend_notify_cal_address
+e_cal_backend_notify_objects_added
+e_cal_backend_notify_objects_modified
+e_cal_backend_notify_objects_removed
 <SUBSECTION Standard>
 E_CAL_BACKEND
 E_IS_CAL_BACKEND
@@ -184,6 +187,23 @@
 </SECTION>
 
 <SECTION>
+<FILE>e-cal-backend-loader-factory</FILE>
+<TITLE>ECalBackendLoaderFactory</TITLE>
+ECalBackendLoaderFactory
+<SUBSECTION Standard>
+E_CAL_BACKEND_LOADER_FACTORY
+E_IS_CAL_BACKEND_LOADER_FACTORY
+E_TYPE_CAL_BACKEND_LOADER_FACTORY
+E_CAL_BACKEND_LOADER_FACTORY_CLASS
+E_IS_CAL_BACKEND_LOADER_FACTORY_CLASS
+E_CAL_BACKEND_LOADER_FACTORY_GET_CLASS
+ECalBackendLoaderFactoryClass
+<SUBSECTION Private>
+ECalBackendLoaderFactoryPrivate
+e_cal_backend_loader_factory_get_type
+</SECTION>
+
+<SECTION>
 <FILE>e-data-cal-factory</FILE>
 <TITLE>EDataCalFactory</TITLE>
 EDataCalFactory

Added: trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-loader-factory.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-loader-factory.sgml	Fri Oct 24 11:57:23 2008
@@ -0,0 +1,26 @@
+<!-- ##### SECTION Title ##### -->
+ECalBackendLoaderFactory
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT ECalBackendLoaderFactory ##### -->
+<para>
+
+</para>
+
+ parent_object: 
+

Modified: trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend.sgml
==============================================================================
--- trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend.sgml	(original)
+++ trunk/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend.sgml	Fri Oct 24 11:57:23 2008
@@ -488,3 +488,33 @@
 @address: 
 
 
+<!-- ##### FUNCTION e_cal_backend_notify_objects_added ##### -->
+<para>
+
+</para>
+
+ backend: 
+ query: 
+ objects: 
+
+
+<!-- ##### FUNCTION e_cal_backend_notify_objects_modified ##### -->
+<para>
+
+</para>
+
+ backend: 
+ query: 
+ objects: 
+
+
+<!-- ##### FUNCTION e_cal_backend_notify_objects_removed ##### -->
+<para>
+
+</para>
+
+ backend: 
+ query: 
+ ids: 
+
+

Modified: trunk/docs/reference/libebackend/libebackend-docs.xml
==============================================================================
--- trunk/docs/reference/libebackend/libebackend-docs.xml	(original)
+++ trunk/docs/reference/libebackend/libebackend-docs.xml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
-    <title>Evolution API Reference: libebackend, backend utility library</title>
+    <title>Evolution-Data-Server Manual: Backend Utilities (libebackend)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libebackend, backend utility library</title>
+    <title>Evolution-Data-Server Manual: Backend Utilities (libebackend)</title>
     <xi:include href="xml/e-file-cache.xml"/>
     <xi:include href="xml/e-dbhash.xml"/>
     <xi:include href="xml/e-data-server-module.xml"/>

Modified: trunk/docs/reference/libedataserver/libedataserver-docs.sgml
==============================================================================
--- trunk/docs/reference/libedataserver/libedataserver-docs.sgml	(original)
+++ trunk/docs/reference/libedataserver/libedataserver-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "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: libedataserver, utility library</title>
+    <title>Evolution-Data-Server Manual: Utilities (libedataserver)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libedataserver, utility library</title>
+    <title>Evolution-Data-Server Manual: Utilities (libedataserver)</title>
     <xi:include href="xml/e-account.xml"/>
     <xi:include href="xml/e-account-list.xml"/>
     <xi:include href="xml/e-categories.xml"/>

Modified: trunk/docs/reference/libedataserver/libedataserver-sections.txt
==============================================================================
--- trunk/docs/reference/libedataserver/libedataserver-sections.txt	(original)
+++ trunk/docs/reference/libedataserver/libedataserver-sections.txt	Fri Oct 24 11:57:23 2008
@@ -210,6 +210,8 @@
 e_source_group_set_property
 e_source_group_foreach_property
 e_source_group_to_xml
+e_source_group_equal
+e_source_group_xmlstr_equal
 <SUBSECTION Standard>
 E_SOURCE_GROUP
 E_IS_SOURCE_GROUP
@@ -262,7 +264,6 @@
 e_source_new_from_xml_node
 e_source_new_from_standalone_xml
 e_source_copy
-e_source_equal
 e_source_update_from_xml_node
 e_source_uid_from_xml_node
 e_source_set_group
@@ -289,6 +290,8 @@
 e_source_foreach_property
 e_source_get_duped_property
 e_source_build_absolute_uri
+e_source_equal
+e_source_xmlstr_equal
 <SUBSECTION Standard>
 E_SOURCE
 E_IS_SOURCE

Modified: trunk/docs/reference/libedataserverui/libedataserverui-docs.sgml
==============================================================================
--- trunk/docs/reference/libedataserverui/libedataserverui-docs.sgml	(original)
+++ trunk/docs/reference/libedataserverui/libedataserverui-docs.sgml	Fri Oct 24 11:57:23 2008
@@ -3,11 +3,11 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
-    <title>Evolution API Reference: libedataserverui, graphical utility library</title>
+    <title>Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</title>
   </bookinfo>
 
   <chapter>
-    <title>Evolution API Reference: libedataserverui, graphical utility library</title>
+    <title>Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</title>
     <xi:include href="xml/e-book-auth-util.xml"/>
     <xi:include href="xml/e-categories-dialog.xml"/>
     <xi:include href="xml/e-cell-renderer-color.xml"/>

Modified: trunk/docs/reference/libedataserverui/libedataserverui-sections.txt
==============================================================================
--- trunk/docs/reference/libedataserverui/libedataserverui-sections.txt	(original)
+++ trunk/docs/reference/libedataserverui/libedataserverui-sections.txt	Fri Oct 24 11:57:23 2008
@@ -89,6 +89,8 @@
 <FILE>e-name-selector-entry</FILE>
 <TITLE>ENameSelectorEntry</TITLE>
 MINIMUM_QUERY_LENGTH
+FORCE_SHOW_ADDRESS
+USER_QUERY_FIELDS
 ENameSelectorEntry
 e_name_selector_entry_new
 e_name_selector_entry_peek_contact_store
@@ -97,6 +99,7 @@
 e_name_selector_entry_set_destination_store
 e_name_selector_entry_set_contact_editor_func
 e_name_selector_entry_set_contact_list_editor_func
+ens_util_populate_user_query_fields
 <SUBSECTION Standard>
 E_NAME_SELECTOR_ENTRY
 E_IS_NAME_SELECTOR_ENTRY

Modified: trunk/docs/reference/libedataserverui/tmpl/e-name-selector-entry.sgml
==============================================================================
--- trunk/docs/reference/libedataserverui/tmpl/e-name-selector-entry.sgml	(original)
+++ trunk/docs/reference/libedataserverui/tmpl/e-name-selector-entry.sgml	Fri Oct 24 11:57:23 2008
@@ -24,6 +24,20 @@
 
 
 
+<!-- ##### MACRO FORCE_SHOW_ADDRESS ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO USER_QUERY_FIELDS ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### STRUCT ENameSelectorEntry ##### -->
 <para>
 
@@ -100,3 +114,14 @@
 @func: 
 
 
+<!-- ##### FUNCTION ens_util_populate_user_query_fields ##### -->
+<para>
+
+</para>
+
+ user_query_fields: 
+ cue_str: 
+ encoded_cue_str: 
+ Returns: 
+
+
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]