[evolution-data-server/since-tags] Add "Since: 2.30" tags to the API documentation.
- From: Matthew Barnes <mbarnes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evolution-data-server/since-tags] Add "Since: 2.30" tags to the API documentation.
- Date: Sat, 13 Mar 2010 19:53:58 +0000 (UTC)
commit 25d01516d41ccd4249bf8f66c46cd87c49b3e283
Author: Matthew Barnes <mbarnes redhat com>
Date: Sat Mar 13 14:48:07 2010 -0500
Add "Since: 2.30" tags to the API documentation.
Also create "Index of new symbols in 2.30" index pages in the table
of contents pages, and improve caching of existing full index pages
to reduce build times.
addressbook/libebook/e-error.h | 7 +++++++
addressbook/libedata-book/e-data-book.h | 6 ++++++
calendar/libecal/e-cal-util.h | 6 ++++++
calendar/libecal/e-cal.c | 4 ++++
calendar/libedata-cal/e-cal-backend-sync.c | 2 ++
calendar/libedata-cal/e-cal-backend.c | 2 ++
calendar/libedata-cal/e-data-cal-view.c | 10 ++++++++++
calendar/libedata-cal/e-data-cal.c | 12 ++++++++++++
calendar/libedata-cal/e-data-cal.h | 6 ++++++
camel/camel-cipher-context.c | 2 ++
camel/camel-file-utils.c | 2 ++
camel/camel-folder-summary.c | 9 +++++++++
camel/camel-folder-summary.h | 9 +++++++++
camel/camel-folder.c | 9 +++++++++
camel/camel-mime-part.c | 2 ++
camel/camel-msgport.c | 9 +++++++++
camel/camel-tcp-stream-ssl.c | 8 ++++++++
.../addressbook/libebook/libebook-docs.sgml | 11 +++++++++--
.../libedata-book/libedata-book-docs.sgml | 11 +++++++++--
docs/reference/calendar/libecal/libecal-docs.sgml | 11 +++++++++--
.../calendar/libedata-cal/libedata-cal-docs.sgml | 11 +++++++++--
docs/reference/camel/camel-docs.sgml | 11 +++++++++--
docs/reference/libebackend/libebackend-docs.xml | 12 +++++++++++-
.../libedataserver/libedataserver-docs.sgml | 11 +++++++++--
.../libedataserverui/libedataserverui-docs.sgml | 11 +++++++++--
libebackend/e-offline-listener.c | 17 +++++++++++++++++
libebackend/e-offline-listener.h | 12 ++++++++++++
libedataserverui/e-name-selector-model.c | 4 ++++
libedataserverui/e-source-selector.c | 2 ++
29 files changed, 214 insertions(+), 15 deletions(-)
---
diff --git a/addressbook/libebook/e-error.h b/addressbook/libebook/e-error.h
index f8312c6..c0b4f8b 100644
--- a/addressbook/libebook/e-error.h
+++ b/addressbook/libebook/e-error.h
@@ -1,3 +1,10 @@
+/**
+ * e_return_error_if_fail:
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
#define e_return_error_if_fail(expr,error_code) G_STMT_START{ \
if G_LIKELY(expr) { } else \
{ \
diff --git a/addressbook/libedata-book/e-data-book.h b/addressbook/libedata-book/e-data-book.h
index b7c40c4..51b3d98 100644
--- a/addressbook/libedata-book/e-data-book.h
+++ b/addressbook/libedata-book/e-data-book.h
@@ -49,6 +49,12 @@ struct _EDataBookClass {
};
GQuark e_data_book_error_quark (void);
+
+/**
+ * E_DATA_BOOK_ERROR:
+ *
+ * Since: 2.30
+ **/
#define E_DATA_BOOK_ERROR e_data_book_error_quark ()
EDataBook *e_data_book_new (EBookBackend *backend, ESource *source);
diff --git a/calendar/libecal/e-cal-util.h b/calendar/libecal/e-cal-util.h
index 3ee0cdc..bff89a0 100644
--- a/calendar/libecal/e-cal-util.h
+++ b/calendar/libecal/e-cal-util.h
@@ -127,6 +127,12 @@ gboolean e_cal_util_event_dates_match (icalcomponent *icalcomp1, icalcomponent *
#define CAL_STATIC_CAPABILITY_NO_ORGANIZER "no-organizer"
#define CAL_STATIC_CAPABILITY_DELEGATE_TO_MANY "delegate-to-many"
#define CAL_STATIC_CAPABILITY_HAS_UNACCEPTED_MEETING "has-unaccepted-meeting"
+
+/**
+ * CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED:
+ *
+ * Since: 2.30
+ **/
#define CAL_STATIC_CAPABILITY_REFRESH_SUPPORTED "refresh-supported"
/* Recurrent events. Management for instances */
diff --git a/calendar/libecal/e-cal.c b/calendar/libecal/e-cal.c
index 08181aa..e17cee9 100644
--- a/calendar/libecal/e-cal.c
+++ b/calendar/libecal/e-cal.c
@@ -1352,6 +1352,8 @@ e_cal_open_async (ECal *ecal, gboolean only_if_exists)
* Invokes refresh on a calendar. See @e_cal_get_refresh_supported.
*
* Return value: TRUE if calendar supports refresh and it was invoked, FALSE otherwise.
+ *
+ * Since: 2.30
**/
gboolean
e_cal_refresh (ECal *ecal, GError **error)
@@ -1870,6 +1872,8 @@ e_cal_get_organizer_must_accept (ECal *ecal)
* Checks whether a calendar supports explicit refreshing (see @e_cal_refresh).
*
* Return value: TRUE if the calendar supports refreshing, FALSE otherwise.
+ *
+ * Since: 2.30
*/
gboolean
e_cal_get_refresh_supported (ECal *ecal)
diff --git a/calendar/libedata-cal/e-cal-backend-sync.c b/calendar/libedata-cal/e-cal-backend-sync.c
index c0f584c..8896331 100644
--- a/calendar/libedata-cal/e-cal-backend-sync.c
+++ b/calendar/libedata-cal/e-cal-backend-sync.c
@@ -220,6 +220,8 @@ e_cal_backend_sync_remove (ECalBackendSync *backend, EDataCal *cal)
* Calls the refresh method on the given backend.
*
* Return value: Status code.
+ *
+ * Since: 2.30
*/
ECalBackendSyncStatus
e_cal_backend_sync_refresh (ECalBackendSync *backend, EDataCal *cal)
diff --git a/calendar/libedata-cal/e-cal-backend.c b/calendar/libedata-cal/e-cal-backend.c
index cc2d36c..0d9c8ec 100644
--- a/calendar/libedata-cal/e-cal-backend.c
+++ b/calendar/libedata-cal/e-cal-backend.c
@@ -641,6 +641,8 @@ e_cal_backend_open (ECalBackend *backend, EDataCal *cal, EServerMethodContext co
* @cal: An #EDataCal object.
*
* Refreshes the calendar being accessed by the given backend.
+ *
+ * Since: 2.30
*/
void
e_cal_backend_refresh (ECalBackend *backend, EDataCal *cal, EServerMethodContext context)
diff --git a/calendar/libedata-cal/e-data-cal-view.c b/calendar/libedata-cal/e-data-cal-view.c
index 14174f5..f76f559 100644
--- a/calendar/libedata-cal/e-data-cal-view.c
+++ b/calendar/libedata-cal/e-data-cal-view.c
@@ -204,6 +204,16 @@ e_data_cal_view_new (ECalBackend *backend,
return query;
}
+/**
+ * e_data_cal_view_get_dbus_path:
+ * @view: an #EDataCalView
+ *
+ * Returns the D-Bus path for @view.
+ *
+ * Returns: the D-Bus path for @view
+ *
+ * Since: 2.30
+ **/
const gchar *
e_data_cal_view_get_dbus_path (EDataCalView *view)
{
diff --git a/calendar/libedata-cal/e-data-cal.c b/calendar/libedata-cal/e-data-cal.c
index ab084b5..da2c4b9 100644
--- a/calendar/libedata-cal/e-data-cal.c
+++ b/calendar/libedata-cal/e-data-cal.c
@@ -163,6 +163,16 @@ e_data_cal_new (ECalBackend *backend, ESource *source)
return cal;
}
+/**
+ * e_data_cal_get_source:
+ * @cal: an #EDataCal
+ *
+ * Returns the #ESource for @cal.
+ *
+ * Returns: the #ESource for @cal
+ *
+ * Since: 2.30
+ **/
ESource*
e_data_cal_get_source (EDataCal *cal)
{
@@ -570,6 +580,8 @@ e_data_cal_notify_open (EDataCal *cal, EServerMethodContext context, EDataCalCal
* @status: Status code.
*
* Notifies listeners of the completion of the refresh method call.
+ *
+ * Since: 2.30
*/
void
e_data_cal_notify_refresh (EDataCal *cal, EServerMethodContext context, EDataCalCallStatus status)
diff --git a/calendar/libedata-cal/e-data-cal.h b/calendar/libedata-cal/e-data-cal.h
index 4cd5f1a..94585ac 100644
--- a/calendar/libedata-cal/e-data-cal.h
+++ b/calendar/libedata-cal/e-data-cal.h
@@ -40,6 +40,12 @@ G_BEGIN_DECLS
#define E_IS_DATA_CAL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_DATA_CAL))
GQuark e_data_cal_error_quark (void);
+
+/**
+ * E_DATA_CAL_ERROR:
+ *
+ * Since: 2.30
+ **/
#define E_DATA_CAL_ERROR e_data_cal_error_quark ()
typedef struct _EDataCalPrivate EDataCalPrivate;
diff --git a/camel/camel-cipher-context.c b/camel/camel-cipher-context.c
index 9d5731c..fc4e233 100644
--- a/camel/camel-cipher-context.c
+++ b/camel/camel-cipher-context.c
@@ -486,6 +486,8 @@ camel_cipher_validity_add_certinfo(CamelCipherValidity *vin, enum _camel_cipher_
* camel_cipher_validity_add_certinfo_ex:
*
* Add a cert info to the signer or encrypter info, with extended data set.
+ *
+ * Since: 2.30
**/
void
camel_cipher_validity_add_certinfo_ex (CamelCipherValidity *vin, camel_cipher_validity_mode_t mode, const gchar *name, const gchar *email, gpointer cert_data, void (*cert_data_free)(gpointer cert_data), gpointer (*cert_data_clone)(gpointer cert_data))
diff --git a/camel/camel-file-utils.c b/camel/camel-file-utils.c
index e170c75..55e33cf 100644
--- a/camel/camel-file-utils.c
+++ b/camel/camel-file-utils.c
@@ -761,6 +761,8 @@ camel_file_util_savename(const gchar *filename)
*
* Returns 0 on success or -1 on fail. In the case of failure, errno
* will be set appropriately.
+ *
+ * Since: 2.30
**/
gint
camel_mkdir (const gchar *path, mode_t mode)
diff --git a/camel/camel-folder-summary.c b/camel/camel-folder-summary.c
index 3218a88..ee58a59 100644
--- a/camel/camel-folder-summary.c
+++ b/camel/camel-folder-summary.c
@@ -5079,6 +5079,15 @@ match_content_type (CamelContentType *info_ctype, CamelContentType *ctype)
return TRUE;
}
+/**
+ * camel_folder_summary_guess_content_info:
+ * @mi: a #CamelMessageInfo
+ * @ctype: a #CamelContentType
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
const CamelMessageContentInfo *
camel_folder_summary_guess_content_info (CamelMessageInfo *mi, CamelContentType *ctype)
{
diff --git a/camel/camel-folder-summary.h b/camel/camel-folder-summary.h
index eddea51..a8cf162 100644
--- a/camel/camel-folder-summary.h
+++ b/camel/camel-folder-summary.h
@@ -464,6 +464,15 @@ time_t camel_message_info_time(const CamelMessageInfo *mi, gint id);
#define camel_message_info_user_tags(mi) ((const CamelTag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_TAGS))
#define camel_message_info_headers(mi) ((const struct _camel_header_param *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_HEADERS))
+
+/**
+ * camel_message_info_content:
+ * @mi: a #CamelMessageInfo
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
#define camel_message_info_content(mi) ((const CamelMessageContentInfo *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_CONTENT))
gboolean camel_message_info_user_flag(const CamelMessageInfo *mi, const gchar *id);
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index cce5bef..4a8a02f 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -223,6 +223,15 @@ camel_folder_finalize (CamelObject *object)
g_free(p);
}
+/**
+ * camel_folder_set_lock_async:
+ * @folder: a #CamelFolder
+ * @skip_folder_lock:
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
void
camel_folder_set_lock_async (CamelFolder *folder, gboolean skip_folder_lock)
{
diff --git a/camel/camel-mime-part.c b/camel/camel-mime-part.c
index 37f8522..6677179 100644
--- a/camel/camel-mime-part.c
+++ b/camel/camel-mime-part.c
@@ -454,6 +454,8 @@ camel_mime_part_get_disposition (CamelMimePart *mime_part)
* Returned pointer is owned by #mime_part.
*
* Returns: the disposition structure
+ *
+ * Since: 2.30
**/
const CamelContentDisposition *
camel_mime_part_get_content_disposition (CamelMimePart *mime_part)
diff --git a/camel/camel-msgport.c b/camel/camel-msgport.c
index de5ede3..ca9f0b1 100644
--- a/camel/camel-msgport.c
+++ b/camel/camel-msgport.c
@@ -415,6 +415,15 @@ camel_msgport_try_pop (CamelMsgPort *msgport)
return msg;
}
+/**
+ * camel_msgport_timed_pop:
+ * @msgport: a #CamelMsgPort
+ * @end_time: a #GTimeVal
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
CamelMsg *
camel_msgport_timed_pop (CamelMsgPort *msgport, GTimeVal *end_time)
{
diff --git a/camel/camel-tcp-stream-ssl.c b/camel/camel-tcp-stream-ssl.c
index b1af151..62290c4 100644
--- a/camel/camel-tcp-stream-ssl.c
+++ b/camel/camel-tcp-stream-ssl.c
@@ -1312,6 +1312,14 @@ stream_get_remote_address (CamelTcpStream *stream, socklen_t *len)
return sockaddr_from_praddr(&addr, len);
}
+/**
+ * camel_tcp_stream_ssl_sockfd:
+ * @stream: a #CamelTcpStreamSSL
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
PRFileDesc *
camel_tcp_stream_ssl_sockfd (CamelTcpStreamSSL *stream)
{
diff --git a/docs/reference/addressbook/libebook/libebook-docs.sgml b/docs/reference/addressbook/libebook/libebook-docs.sgml
index 0f3459c..d194713 100644
--- a/docs/reference/addressbook/libebook/libebook-docs.sgml
+++ b/docs/reference/addressbook/libebook/libebook-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Address Book Client (libebook)</title>
@@ -19,7 +21,12 @@
<xi:include href="xml/e-name-western.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
index 49d9943..d50ef16 100644
--- a/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
+++ b/docs/reference/addressbook/libedata-book/libedata-book-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Address Book Backend (libedata-book)</title>
@@ -21,7 +23,12 @@
<xi:include href="xml/ximian-vcard.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/docs/reference/calendar/libecal/libecal-docs.sgml b/docs/reference/calendar/libecal/libecal-docs.sgml
index bbca620..1249b5c 100644
--- a/docs/reference/calendar/libecal/libecal-docs.sgml
+++ b/docs/reference/calendar/libecal/libecal-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"[
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Calendar Client (libecal)</title>
@@ -19,7 +21,12 @@
<xi:include href="xml/e-cal-check-timezones.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
index e4420d6..77dde22 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Calendar Backend (libedata-cal)</title>
@@ -19,7 +21,12 @@
<xi:include href="xml/e-data-cal-view.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/docs/reference/camel/camel-docs.sgml b/docs/reference/camel/camel-docs.sgml
index 83ff756..6d5d168 100644
--- a/docs/reference/camel/camel-docs.sgml
+++ b/docs/reference/camel/camel-docs.sgml
@@ -1,6 +1,7 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY CamelInit SYSTEM "xml/camel.xml">
<!ENTITY CamelAddress SYSTEM "xml/camel-address.xml">
<!ENTITY CamelArg SYSTEM "xml/camel-arg.xml">
@@ -321,11 +322,17 @@
&CamelProcess;
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
- <index role="deprecated">
+ <index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</part>
</book>
diff --git a/docs/reference/libebackend/libebackend-docs.xml b/docs/reference/libebackend/libebackend-docs.xml
index 291df75..763cfd1 100644
--- a/docs/reference/libebackend/libebackend-docs.xml
+++ b/docs/reference/libebackend/libebackend-docs.xml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Backend Utilities (libebackend)</title>
@@ -14,4 +16,12 @@
<xi:include href="xml/e-db3-utils.xml"/>
<xi:include href="xml/e-offline-listener.xml"/>
</chapter>
+
+ <index>
+ <title>Index</title>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
+ </index>
</book>
diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml
index 738ad8c..1ffa410 100644
--- a/docs/reference/libedataserver/libedataserver-docs.sgml
+++ b/docs/reference/libedataserver/libedataserver-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Utilities (libedataserver)</title>
@@ -33,7 +35,12 @@
<xi:include href="xml/md5-utils.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/docs/reference/libedataserverui/libedataserverui-docs.sgml b/docs/reference/libedataserverui/libedataserverui-docs.sgml
index 7b539f5..cd119c8 100644
--- a/docs/reference/libedataserverui/libedataserverui-docs.sgml
+++ b/docs/reference/libedataserverui/libedataserverui-docs.sgml
@@ -1,6 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>Evolution-Data-Server Manual: Graphical Utilities (libedataserverui)</title>
@@ -28,7 +30,12 @@
<xi:include href="xml/e-tree-model-generator.xml"/>
</chapter>
- <index>
+ <index id="api-index-full">
<title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-2.30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
</index>
</book>
diff --git a/libebackend/e-offline-listener.c b/libebackend/e-offline-listener.c
index b8a3888..c4a3808 100644
--- a/libebackend/e-offline-listener.c
+++ b/libebackend/e-offline-listener.c
@@ -96,6 +96,15 @@ setup_offline_listener (EOfflineListener *eol)
set_online_status (eol, priv->is_offline_now);
}
+/**
+ * e_offline_listener_new:
+ *
+ * Returns a new #EOfflineListener.
+ *
+ * Returns: a new #EOfflineListener
+ *
+ * Since: 2.30
+ **/
EOfflineListener*
e_offline_listener_new (void)
{
@@ -163,6 +172,14 @@ e_offline_listener_class_init (EOfflineListenerClass *klass)
G_TYPE_NONE, 0);
}
+/**
+ * e_offline_listener_get_state:
+ * @eol: an #EOfflineListener
+ *
+ * FIXME Document me!
+ *
+ * Since: 2.30
+ **/
EOfflineListenerState
e_offline_listener_get_state (EOfflineListener *eol)
{
diff --git a/libebackend/e-offline-listener.h b/libebackend/e-offline-listener.h
index 68e4e27..d92840c 100644
--- a/libebackend/e-offline-listener.h
+++ b/libebackend/e-offline-listener.h
@@ -41,11 +41,23 @@ typedef struct _EOfflineListener EOfflineListener;
typedef struct _EOfflineListenerPrivate EOfflineListenerPrivate;
typedef struct _EOfflineListenerClass EOfflineListenerClass;
+/**
+ * EOfflineListenerState:
+ * @EOL_STATE_OFFLINE:
+ * @EOL_STATE_ONLINE:
+ *
+ * Since: 2.30
+ **/
typedef enum {
EOL_STATE_OFFLINE = 0,
EOL_STATE_ONLINE = 1
} EOfflineListenerState;
+/**
+ * EOfflineListener:
+ *
+ * Since: 2.30
+ **/
struct _EOfflineListener {
GObject parent;
EOfflineListenerPrivate *priv;
diff --git a/libedataserverui/e-name-selector-model.c b/libedataserverui/e-name-selector-model.c
index 1a0d434..439a92d 100644
--- a/libedataserverui/e-name-selector-model.c
+++ b/libedataserverui/e-name-selector-model.c
@@ -537,6 +537,8 @@ e_name_selector_model_peek_section (ENameSelectorModel *name_selector_model, con
* Returns list of all email from @contact, without all used
* in any section. Each item is a string, an email address.
* Returned list should be freed with @e_name_selector_model_free_emails_list.
+ *
+ * Since: 2.30
**/
GList *
e_name_selector_model_get_contact_emails_without_used (ENameSelectorModel *name_selector_model, EContact *contact, gboolean remove_used)
@@ -605,6 +607,8 @@ e_name_selector_model_get_contact_emails_without_used (ENameSelectorModel *name_
* @email_list: list of emails returned from @e_name_selector_model_get_contact_emails_without_used
*
* Frees a list of emails returned from @e_name_selector_model_get_contact_emails_without_used.
+ *
+ * Since: 2.30
**/
void
e_name_selector_model_free_emails_list (GList *email_list)
diff --git a/libedataserverui/e-source-selector.c b/libedataserverui/e-source-selector.c
index 07d3aa5..f03f5e7 100644
--- a/libedataserverui/e-source-selector.c
+++ b/libedataserverui/e-source-selector.c
@@ -1594,6 +1594,8 @@ source_selector_select_exclusive_foreach (GtkTreeModel *model,
* @source: An #ESource.
*
* Select @source in @selector and unselect all others.
+ *
+ * Since: 2.30
**/
void
e_source_selector_select_exclusive (ESourceSelector *selector,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]