GNOME.org
 

[evolution-data-server] Update API documentation.

commit 98cc94544940206ce5bbc4ec162295b393f91870
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sat Sep 11 09:50:25 2010 -0400

    Update API documentation.

 addressbook/libebook/e-book.h                      |    6 +
 calendar/libecal/e-cal-recur.c                     |   27 +++--
 calendar/libecal/e-cal-util.c                      |    9 +-
 calendar/libedata-cal/e-cal-backend-intervaltree.c |   35 ++++-
 calendar/libedata-cal/e-cal-backend-intervaltree.h |   34 ++---
 calendar/libedata-cal/e-cal-backend-sexp.c         |    1 +
 calendar/libedata-cal/e-cal-backend-sexp.h         |    7 +-
 calendar/libedata-cal/e-cal-backend-store.c        |    4 +-
 camel/camel-tcp-stream-raw.h                       |    7 +-
 camel/camel-tcp-stream.c                           |    6 +
 .../addressbook/libebook/libebook-sections.txt     |    1 +
 .../addressbook/libebook/tmpl/e-book.sgml          |   13 ++-
 .../calendar/libecal/libecal-sections.txt          |    3 +
 .../libecal/tmpl/e-cal-check-timezones.sgml        |    3 +
 .../calendar/libecal/tmpl/e-cal-recur.sgml         |   24 ++++
 .../calendar/libecal/tmpl/e-cal-util.sgml          |   14 ++
 .../calendar/libedata-cal/libedata-cal-docs.sgml   |    1 +
 .../libedata-cal/libedata-cal-sections.txt         |   28 ++++
 .../libedata-cal/tmpl/e-cal-backend-sexp.sgml      |   11 ++
 .../libedata-cal/tmpl/e-cal-backend-store.sgml     |   34 +++++
 .../calendar/libedata-cal/tmpl/e-intervaltree.sgml |   81 +++++++++++
 docs/reference/camel/camel-sections.txt            |    4 +
 .../reference/camel/tmpl/camel-cipher-context.sgml |    6 +
 .../reference/camel/tmpl/camel-tcp-stream-raw.sgml |   15 ++
 docs/reference/camel/tmpl/camel-tcp-stream.sgml    |    9 ++
 .../libedataserver/libedataserver-docs.sgml        |    1 +
 .../libedataserver/libedataserver-sections.txt     |   20 +++
 .../reference/libedataserver/tmpl/e-debug-log.sgml |  146 ++++++++++++++++++++
 docs/reference/libedataserver/tmpl/e-sexp.sgml     |   14 ++
 libedataserver/e-debug-log.c                       |   55 ++++++++
 libedataserver/e-debug-log.h                       |   17 +++
 libedataserver/e-sexp.c                            |    1 +
 32 files changed, 589 insertions(+), 48 deletions(-)
---
diff --git a/addressbook/libebook/e-book.h b/addressbook/libebook/e-book.h
index 608f1dd..46e4971 100644
--- a/addressbook/libebook/e-book.h
+++ b/addressbook/libebook/e-book.h
@@ -45,6 +45,12 @@ typedef void (*EBookCallback) (EBook *book, EBookStatus status, gpointer closure
  * Since: 2.32
  **/
 typedef void (*EBookAsyncCallback) (EBook *book, const GError *error, gpointer closure);
+
+/**
+ * EBookOpenProgressCallback:
+ *
+ * Since: 2.32
+ **/
 typedef void (*EBookOpenProgressCallback)     (EBook          *book,
 					       const gchar     *status_message,
 					       gshort           percent,
diff --git a/calendar/libecal/e-cal-recur.c b/calendar/libecal/e-cal-recur.c
index 24e2c14..6cad7e4 100644
--- a/calendar/libecal/e-cal-recur.c
+++ b/calendar/libecal/e-cal-recur.c
@@ -904,7 +904,6 @@ array_to_list (gshort *array, gint max_elements)
 
 /** 
  * e_cal_recur_get_enddate
- * 
  * @ir: RRULE or EXRULE recurrence 
  * @prop: An RRULE or EXRULE #icalproperty. 
  * @zone: The DTSTART timezone, used for converting the UNTIL property if it
@@ -913,9 +912,11 @@ array_to_list (gshort *array, gint max_elements)
  * given @zone timezone. This is needed if the DTSTART is a DATE or floating
  * time.
  * 
- * @return End timepoint of giben event
- *
  * Finds out end time of (reccurent) event.
+ *
+ * Returns: End timepoint of given event
+ *
+ * Since: 2.32
  */
 time_t
 e_cal_recur_obtain_enddate (struct icalrecurrencetype *ir, icalproperty *prop,
@@ -3772,13 +3773,19 @@ cal_obj_time_to_string		(CalObjTime	*cotime)
 }
 #endif
 
-/* This recalculates the end dates for recurrence & exception rules which use
-   the COUNT property. If refresh is TRUE it will recalculate all enddates
-   for rules which use COUNT. If refresh is FALSE, it will only calculate
-   the enddate if it hasn't already been set. It returns TRUE if the component
-   was changed, i.e. if the component should be saved at some point.
-   We store the enddate in the "X-EVOLUTION-ENDDATE" parameter of the RRULE
-   or EXRULE. */
+/**
+ * e_cal_recur_ensure_end_dates:
+ *
+ * This recalculates the end dates for recurrence & exception rules which use
+ * the COUNT property. If @refresh is %TRUE it will recalculate all enddates
+ * for rules which use COUNT. If @refresh is %FALSE, it will only calculate
+ * the enddate if it hasn't already been set. It returns %TRUE if the component
+ * was changed, i.e. if the component should be saved at some point.
+ * We store the enddate in the "X-EVOLUTION-ENDDATE" parameter of the RRULE
+ * or EXRULE.
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_cal_recur_ensure_end_dates (ECalComponent	*comp,
 			    gboolean		 refresh,
diff --git a/calendar/libecal/e-cal-util.c b/calendar/libecal/e-cal-util.c
index 36a3bc8..f67e1fc 100644
--- a/calendar/libecal/e-cal-util.c
+++ b/calendar/libecal/e-cal-util.c
@@ -1193,8 +1193,13 @@ componenttime_to_utc_timet (const ECalComponentDateTime* dt_time,
 }
 
 /**
- * Find out, when the component starts and stops. Be careful about recurrences.
- */
+ * e_cal_util_get_component_occur_times:
+ *
+ * Find out when the component starts and stops, being careful about
+ * recurrences.
+ *
+ * Since: 2.32
+ **/
 void
 e_cal_util_get_component_occur_times (ECalComponent *comp,
 			   time_t* start,
diff --git a/calendar/libedata-cal/e-cal-backend-intervaltree.c b/calendar/libedata-cal/e-cal-backend-intervaltree.c
index 09c7897..56d2b83 100644
--- a/calendar/libedata-cal/e-cal-backend-intervaltree.c
+++ b/calendar/libedata-cal/e-cal-backend-intervaltree.c
@@ -43,8 +43,10 @@ G_DEFINE_TYPE (EIntervalTree, e_intervaltree, G_TYPE_OBJECT)
 	(G_TYPE_INSTANCE_GET_PRIVATE \
 	((obj), E_TYPE_INTERVALTREE, EIntervalTreePrivate))
 
-EIntervalNode* 
-e_intervaltree_node_next (EIntervalTree *tree, EIntervalNode *x);
+typedef struct _EIntervalNode EIntervalNode;
+
+static EIntervalNode* 
+intervaltree_node_next (EIntervalTree *tree, EIntervalNode *x);
 
 struct _EIntervalNode
 {
@@ -266,6 +268,7 @@ binary_tree_insert (EIntervalTree *tree, EIntervalNode *z)
  * @key: the key to insert.
  * @comp: Component
  * 
+ * Since: 2.32
  **/
 gboolean
 e_intervaltree_insert (EIntervalTree *tree, time_t start, time_t end, ECalComponent *comp)
@@ -355,8 +358,8 @@ e_intervaltree_insert (EIntervalTree *tree, time_t start, time_t end, ECalCompon
 	return TRUE;
 }
 
-EIntervalNode* 
-e_intervaltree_node_next (EIntervalTree *tree, EIntervalNode *x)
+static EIntervalNode* 
+intervaltree_node_next (EIntervalTree *tree, EIntervalNode *x)
 {
 	EIntervalTreePrivate *priv = tree->priv; 
 	EIntervalNode *y;
@@ -390,7 +393,14 @@ e_intervaltree_node_next (EIntervalTree *tree, EIntervalNode *x)
 	return y;
 }
 
-void e_intervaltree_destroy (EIntervalTree *tree)
+/**
+ * e_intervaltree_destroy:
+ * @tree: an #EIntervalTree
+ *
+ * Since: 2.32
+ **/
+void
+e_intervaltree_destroy (EIntervalTree *tree)
 {
 	EIntervalTreePrivate *priv = tree->priv;
 	EIntervalNode *node; 
@@ -507,8 +517,9 @@ e_intervaltree_fixup_deletion (EIntervalTree *tree, EIntervalNode *x)
  * @start: start of the interval
  * @end: end of the interval
  * 
- * Returns list of nodes that overlaps given interval
- * or NULL.
+ * Returns list of nodes that overlaps given interval or %NULL.
+ *
+ * Since: 2.32
  **/
 GList*
 e_intervaltree_search (EIntervalTree *tree, time_t start, time_t end)
@@ -615,6 +626,12 @@ e_intervaltree_search_component (EIntervalTree *tree,
 	return g_hash_table_lookup (priv->id_node_hash, component_key(searched_uid, searched_rid));
 }
 
+/**
+ * e_intervaltree_remove:
+ * @tree: an #EIntervalTree
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_intervaltree_remove (EIntervalTree *tree,
 		       const gchar *uid,
@@ -640,7 +657,7 @@ e_intervaltree_remove (EIntervalTree *tree,
 		return FALSE;
 	}
 
-	y = ((z->left == nil) || (z->right == nil)) ? z : e_intervaltree_node_next (tree, z);
+	y = ((z->left == nil) || (z->right == nil)) ? z : intervaltree_node_next (tree, z);
 	x = (y->left == nil) ? y->right : y->left;
 	/* y is to be spliced out. x is it's only child */
 
@@ -768,6 +785,8 @@ e_intervaltree_init (EIntervalTree *tree)
  * Creates a new #EIntervalTree.
  *
  * Returns: The newly-created #EIntervalTree.
+ *
+ * Since: 2.32
  **/
 EIntervalTree*
 e_intervaltree_new (void)
diff --git a/calendar/libedata-cal/e-cal-backend-intervaltree.h b/calendar/libedata-cal/e-cal-backend-intervaltree.h
index a1c529a..78ce86f 100644
--- a/calendar/libedata-cal/e-cal-backend-intervaltree.h
+++ b/calendar/libedata-cal/e-cal-backend-intervaltree.h
@@ -20,19 +20,9 @@
  *
  */
 
-#ifndef __E_INTERVALTREE_H__
-#define __E_INTERVALTREE_H__
-
-#ifdef __cplusplus
-extern "C" {
-#pragma }
-#endif /* __cplusplus */
-
-#include <glib.h>
-//#include <glib/glist.h>
-// EDS opt
-#include <glib-object.h>
-#include <gio/gio.h>
+#ifndef E_INTERVALTREE_H
+#define E_INTERVALTREE_H
+
 #include <libecal/e-cal-component.h>
 #include <libecal/e-cal-recur.h>
 
@@ -44,6 +34,9 @@ extern "C" {
 #define E_IS_INTERVALTREE(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), E_TYPE_INTERVALTREE))
 #define E_IS_INTERVALTREE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_INTERVALTREE))
 #define E_INTERVALTREE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), E_TYPE_INTERVALTREE, EIntervalTreeClass))
+
+G_BEGIN_DECLS
+
 /* #undef E_INTERVALTREE_DEBUG */
 /*
  * Implementation of the interval node as described in Introduction to Algorithms
@@ -56,8 +49,12 @@ extern "C" {
 typedef struct _EIntervalTree EIntervalTree;
 typedef struct _EIntervalTreeClass EIntervalTreeClass;
 typedef struct _EIntervalTreePrivate EIntervalTreePrivate;
-typedef struct _EIntervalNode EIntervalNode;
 
+/**
+ * EIntervalTree:
+ *
+ * Since: 2.32
+ **/
 struct _EIntervalTree
 {
 	GObject parent;
@@ -77,8 +74,6 @@ gboolean e_intervaltree_insert (EIntervalTree *tree, time_t start, time_t end, E
 
 gboolean e_intervaltree_remove (EIntervalTree *tree, const gchar *uid, const gchar *rid);
 
-gpointer e_intervaltree_lookup (EIntervalTree *tree, time_t start, time_t end);
-
 void e_intervaltree_destroy (EIntervalTree *tree);
 
 GList*
@@ -87,9 +82,6 @@ e_intervaltree_search (EIntervalTree *tree, time_t start, time_t end);
 void e_intervaltree_dump (EIntervalTree *tree);
 #endif
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
-
+G_END_DECLS
 
-#endif /* __E_INTERVALTREE_H__ */
+#endif /* E_INTERVALTREE_H */
diff --git a/calendar/libedata-cal/e-cal-backend-sexp.c b/calendar/libedata-cal/e-cal-backend-sexp.c
index 7c35881..d107a84 100644
--- a/calendar/libedata-cal/e-cal-backend-sexp.c
+++ b/calendar/libedata-cal/e-cal-backend-sexp.c
@@ -1280,6 +1280,7 @@ static struct {
  *
  * Determines biggest time window given by expressions "occur-in-range" in sexp.
  *
+ * Since: 2.32
  */
 gboolean
 e_cal_backend_sexp_evaluate_occur_times(ECalBackendSExp *sexp, time_t *start, time_t *end)
diff --git a/calendar/libedata-cal/e-cal-backend-sexp.h b/calendar/libedata-cal/e-cal-backend-sexp.h
index 71ae30e..73dfc20 100644
--- a/calendar/libedata-cal/e-cal-backend-sexp.h
+++ b/calendar/libedata-cal/e-cal-backend-sexp.h
@@ -30,8 +30,6 @@
 #include <libedata-cal/e-cal-backend.h>
 #include <libedataserver/e-sexp.h>
 
-G_BEGIN_DECLS
-
 #define E_TYPE_CAL_BACKEND_SEXP        (e_cal_backend_sexp_get_type ())
 #define E_CAL_BACKEND_SEXP(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), E_TYPE_CAL_BACKEND_SEXP, ECalBackendSExp))
 #define E_CAL_BACKEND_SEXP_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), E_CAL_BACKEND_TYPE, ECalBackendSExpClass))
@@ -39,6 +37,8 @@ G_BEGIN_DECLS
 #define E_IS_CAL_BACKEND_SEXP_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_CAL_BACKEND_SEXP))
 #define E_CAL_BACKEND_SEXP_GET_CLASS(k) (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TYPE_CAL_BACKEND_SEXP, CALBackendSExpClass))
 
+G_BEGIN_DECLS
+
 typedef struct _ECalBackendSExpPrivate ECalBackendSExpPrivate;
 
 struct _ECalBackendSExp {
@@ -71,8 +71,7 @@ ESExpResult *e_cal_backend_sexp_func_time_add_day   (ESExp *esexp, gint argc, ES
 ESExpResult *e_cal_backend_sexp_func_time_day_begin (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data);
 ESExpResult *e_cal_backend_sexp_func_time_day_end   (ESExp *esexp, gint argc, ESExpResult **argv, gpointer data);
 gboolean	e_cal_backend_sexp_evaluate_occur_times	(ECalBackendSExp *sexp, time_t *start, time_t *end);
-gboolean 	e_cal_backend_sexp_is_a_time_function(const char *function_name);
-gboolean	e_cal_backend_sexp_is_a_generator_function(const char *function_name);
+
 G_END_DECLS
 
 #endif /* __E_CAL_BACKEND_SEXP_H__ */
diff --git a/calendar/libedata-cal/e-cal-backend-store.c b/calendar/libedata-cal/e-cal-backend-store.c
index 1cbd060..0ef6aa5 100644
--- a/calendar/libedata-cal/e-cal-backend-store.c
+++ b/calendar/libedata-cal/e-cal-backend-store.c
@@ -403,6 +403,8 @@ e_cal_backend_store_get_components (ECalBackendStore *store)
  *
  * Return value: A list of the components. Each item in the list is
  * an #ECalComponent, which should be freed when no longer needed.
+ *
+ * Since: 2.32
  */
 GSList *
 e_cal_backend_store_get_components_occuring_in_range (ECalBackendStore *store, time_t start, time_t end)
@@ -507,7 +509,7 @@ e_cal_backend_store_freeze_changes (ECalBackendStore *store)
 /**
  * e_cal_backend_store_interval_tree_add_comp:
  *
- * Since: 2.28
+ * Since: 2.32
  **/
 void
 e_cal_backend_store_interval_tree_add_comp (ECalBackendStore *store, ECalComponent *comp, time_t occurence_start, time_t occurence_end)
diff --git a/camel/camel-tcp-stream-raw.h b/camel/camel-tcp-stream-raw.h
index 78b0397..f12acda 100644
--- a/camel/camel-tcp-stream-raw.h
+++ b/camel/camel-tcp-stream-raw.h
@@ -50,6 +50,11 @@
 
 G_BEGIN_DECLS
 
+/**
+ * CAMEL_PROXY_ERROR:
+ *
+ * Since: 2.32
+ **/
 #define CAMEL_PROXY_ERROR (camel_proxy_error_quark ())
 
 typedef struct _CamelTcpStreamRaw CamelTcpStreamRaw;
@@ -68,7 +73,7 @@ struct _CamelTcpStreamRawClass {
 /**
  * CamelProxyError:
  *
- * Since: 3.0
+ * Since: 2.32
  */
 typedef enum {
 	CAMEL_PROXY_ERROR_PROXY_NOT_SUPPORTED,
diff --git a/camel/camel-tcp-stream.c b/camel/camel-tcp-stream.c
index 1738051..a9d3587 100644
--- a/camel/camel-tcp-stream.c
+++ b/camel/camel-tcp-stream.c
@@ -213,6 +213,12 @@ camel_tcp_stream_get_remote_address (CamelTcpStream *stream,
 	return class->get_remote_address (stream, len);
 }
 
+/**
+ * camel_tcp_stream_get_file_desc:
+ * @stream: a #CamelTcpStream
+ *
+ * Since: 2.32
+ **/
 PRFileDesc *
 camel_tcp_stream_get_file_desc (CamelTcpStream *stream)
 {
diff --git a/docs/reference/addressbook/libebook/libebook-sections.txt b/docs/reference/addressbook/libebook/libebook-sections.txt
index 46e35d4..c13e406 100644
--- a/docs/reference/addressbook/libebook/libebook-sections.txt
+++ b/docs/reference/addressbook/libebook/libebook-sections.txt
@@ -60,6 +60,7 @@ e_return_error_if_fail
 e_return_async_error_if_fail
 e_return_ex_async_error_val_if_fail
 EBookAsyncCallback
+EBookOpenProgressCallback
 EBookIdAsyncCallback
 EBookContactAsyncCallback
 EBookListAsyncCallback
diff --git a/docs/reference/addressbook/libebook/tmpl/e-book.sgml b/docs/reference/addressbook/libebook/tmpl/e-book.sgml
index d52c1aa..2d7a8fe 100644
--- a/docs/reference/addressbook/libebook/tmpl/e-book.sgml
+++ b/docs/reference/addressbook/libebook/tmpl/e-book.sgml
@@ -448,6 +448,17 @@ The writable status for this book is being reported.
 @closure: 
 
 
+<!-- ##### USER_FUNCTION EBookOpenProgressCallback ##### -->
+<para>
+
+</para>
+
+ book: 
+ status_message: 
+ percent: 
+ closure: 
+
+
 <!-- ##### USER_FUNCTION EBookIdAsyncCallback ##### -->
 <para>
 
@@ -520,7 +531,7 @@ The writable status for this book is being reported.
 
 @book: 
 @status_message: 
- Param3: 
+ percent: 
 @closure: 
 
 
diff --git a/docs/reference/calendar/libecal/libecal-sections.txt b/docs/reference/calendar/libecal/libecal-sections.txt
index ff44c7a..0f602cd 100644
--- a/docs/reference/calendar/libecal/libecal-sections.txt
+++ b/docs/reference/calendar/libecal/libecal-sections.txt
@@ -259,6 +259,8 @@ e_cal_get_type
 ECalRecurInstanceFn
 ECalRecurResolveTimezoneFn
 e_cal_recur_generate_instances
+e_cal_recur_obtain_enddate
+e_cal_recur_ensure_end_dates
 e_cal_get_recur_nth
 e_cal_recur_nth
 </SECTION>
@@ -359,6 +361,7 @@ e_cal_util_construct_instance
 e_cal_util_remove_instances
 e_cal_util_get_system_timezone_location
 e_cal_util_get_system_timezone
+e_cal_util_get_component_occur_times
 </SECTION>
 
 <SECTION>
diff --git a/docs/reference/calendar/libecal/tmpl/e-cal-check-timezones.sgml b/docs/reference/calendar/libecal/tmpl/e-cal-check-timezones.sgml
index bed62ad..e1d9ab3 100644
--- a/docs/reference/calendar/libecal/tmpl/e-cal-check-timezones.sgml
+++ b/docs/reference/calendar/libecal/tmpl/e-cal-check-timezones.sgml
@@ -58,6 +58,9 @@ e-cal-check-timezones
 @const gchar *tzid, gconstpointer custom, GError **error:
 @const gchar *tzid, gconstpointer custom, GError **error:
 @const gchar *tzid, gconstpointer custom, GError **error:
+ const gchar *tzid, gconstpointer custom, GError **error:
+ const gchar *tzid, gconstpointer custom, GError **error:
+ const gchar *tzid, gconstpointer custom, GError **error:
 @const gchar *tzid, gconstpointer custom, GError **error: 
 @custom: 
 @error: 
diff --git a/docs/reference/calendar/libecal/tmpl/e-cal-recur.sgml b/docs/reference/calendar/libecal/tmpl/e-cal-recur.sgml
index 22a551c..346aa30 100644
--- a/docs/reference/calendar/libecal/tmpl/e-cal-recur.sgml
+++ b/docs/reference/calendar/libecal/tmpl/e-cal-recur.sgml
@@ -57,6 +57,30 @@ Functions to expand recurrences for recurrent appointments.
 @default_timezone: 
 
 
+<!-- ##### FUNCTION e_cal_recur_obtain_enddate ##### -->
+<para>
+
+</para>
+
+ ir: 
+ prop: 
+ zone: 
+ convert_end_date: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_cal_recur_ensure_end_dates ##### -->
+<para>
+
+</para>
+
+ comp: 
+ refresh: 
+ tz_cb: 
+ tz_cb_data: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_cal_get_recur_nth ##### -->
 <para>
 
diff --git a/docs/reference/calendar/libecal/tmpl/e-cal-util.sgml b/docs/reference/calendar/libecal/tmpl/e-cal-util.sgml
index 20f32ba..aa464d7 100644
--- a/docs/reference/calendar/libecal/tmpl/e-cal-util.sgml
+++ b/docs/reference/calendar/libecal/tmpl/e-cal-util.sgml
@@ -460,3 +460,17 @@ Various utility functions.
 @Returns: 
 
 
+<!-- ##### FUNCTION e_cal_util_get_component_occur_times ##### -->
+<para>
+
+</para>
+
+ comp: 
+ start: 
+ end: 
+ tz_cb: 
+ tz_cb_data: 
+ default_timezone: 
+ kind: 
+
+
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
index 2539c93..15f9136 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-docs.sgml
@@ -22,6 +22,7 @@
     <xi:include href="xml/e-data-cal.xml"/>
     <xi:include href="xml/e-data-cal-factory.xml"/>
     <xi:include href="xml/e-data-cal-view.xml"/>
+    <xi:include href="xml/e-intervaltree.xml"/>
   </chapter>
 
   <index id="api-index-full">
diff --git a/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt b/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
index 0eb7141..ddfeed8 100644
--- a/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
+++ b/docs/reference/calendar/libedata-cal/libedata-cal-sections.txt
@@ -55,6 +55,30 @@ e_cal_backend_factory_get_type
 </SECTION>
 
 <SECTION>
+<FILE>e-intervaltree</FILE>
+<TITLE>EIntervalTree</TITLE>
+EIntervalTree
+e_intervaltree_new
+e_intervaltree_insert
+e_intervaltree_remove
+e_intervaltree_destroy
+e_intervaltree_search
+<SUBSECTION Standard>
+E_INTERVALTREE
+E_IS_INTERVALTREE
+E_TYPE_INTERVALTREE
+E_INTERVALTREE_CLASS
+E_IS_INTERVALTREE_CLASS
+E_INTERVALTREE_GET_CLASS
+EIntervalTreeClass
+<SUBSECTION Private>
+E_INTERVALTREE_DEBUG
+EIntervalTreePrivate
+e_intervaltree_get_type
+e_intervaltree_dump
+</SECTION>
+
+<SECTION>
 <FILE>e-cal-backend-sexp</FILE>
 <TITLE>ECalBackendSExp</TITLE>
 e_cal_backend_sexp_new
@@ -66,6 +90,7 @@ e_cal_backend_sexp_func_make_time
 e_cal_backend_sexp_func_time_add_day
 e_cal_backend_sexp_func_time_day_begin
 e_cal_backend_sexp_func_time_day_end
+e_cal_backend_sexp_evaluate_occur_times
 <SUBSECTION Standard>
 E_CAL_BACKEND_SEXP
 E_IS_CAL_BACKEND_SEXP
@@ -219,6 +244,7 @@ e_cal_backend_store_is_loaded
 e_cal_backend_store_remove
 e_cal_backend_store_clean
 e_cal_backend_store_get_component
+e_cal_backend_store_put_component_with_time_range
 e_cal_backend_store_put_component
 e_cal_backend_store_remove_component
 e_cal_backend_store_has_component
@@ -229,11 +255,13 @@ e_cal_backend_store_get_default_timezone
 e_cal_backend_store_set_default_timezone
 e_cal_backend_store_get_components_by_uid
 e_cal_backend_store_get_components
+e_cal_backend_store_get_components_occuring_in_range
 e_cal_backend_store_get_component_ids
 e_cal_backend_store_get_key_value
 e_cal_backend_store_put_key_value
 e_cal_backend_store_thaw_changes
 e_cal_backend_store_freeze_changes
+e_cal_backend_store_interval_tree_add_comp
 <SUBSECTION Standard>
 E_CAL_BACKEND_STORE
 E_IS_CAL_BACKEND_STORE
diff --git a/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-sexp.sgml b/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-sexp.sgml
index db4ebd2..b1bfc62 100644
--- a/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-sexp.sgml
+++ b/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-sexp.sgml
@@ -120,3 +120,14 @@ Regular expressions for calendar searches.
 @Returns: 
 
 
+<!-- ##### FUNCTION e_cal_backend_sexp_evaluate_occur_times ##### -->
+<para>
+
+</para>
+
+ sexp: 
+ start: 
+ end: 
+ Returns: 
+
+
diff --git a/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-store.sgml b/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-store.sgml
index a7820d8..4e49cce 100644
--- a/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-store.sgml
+++ b/docs/reference/calendar/libedata-cal/tmpl/e-cal-backend-store.sgml
@@ -84,6 +84,18 @@ ECalBackendStore
 @Returns: 
 
 
+<!-- ##### FUNCTION e_cal_backend_store_put_component_with_time_range ##### -->
+<para>
+
+</para>
+
+ store: 
+ comp: 
+ occurence_start: 
+ occurence_end: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_cal_backend_store_put_component ##### -->
 <para>
 
@@ -184,6 +196,17 @@ ECalBackendStore
 @Returns: 
 
 
+<!-- ##### FUNCTION e_cal_backend_store_get_components_occuring_in_range ##### -->
+<para>
+
+</para>
+
+ store: 
+ start: 
+ end: 
+ Returns: 
+
+
 <!-- ##### FUNCTION e_cal_backend_store_get_component_ids ##### -->
 <para>
 
@@ -230,3 +253,14 @@ ECalBackendStore
 @store: 
 
 
+<!-- ##### FUNCTION e_cal_backend_store_interval_tree_add_comp ##### -->
+<para>
+
+</para>
+
+ store: 
+ comp: 
+ start: 
+ end: 
+
+
diff --git a/docs/reference/calendar/libedata-cal/tmpl/e-intervaltree.sgml b/docs/reference/calendar/libedata-cal/tmpl/e-intervaltree.sgml
new file mode 100644
index 0000000..16285b5
--- /dev/null
+++ b/docs/reference/calendar/libedata-cal/tmpl/e-intervaltree.sgml
@@ -0,0 +1,81 @@
+<!-- ##### SECTION Title ##### -->
+EIntervalTree
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### STRUCT EIntervalTree ##### -->
+<para>
+
+</para>
+
+ parent: 
+ priv: 
+
+<!-- ##### FUNCTION e_intervaltree_new ##### -->
+<para>
+
+</para>
+
+ void: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_intervaltree_insert ##### -->
+<para>
+
+</para>
+
+ tree: 
+ start: 
+ end: 
+ comp: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_intervaltree_remove ##### -->
+<para>
+
+</para>
+
+ tree: 
+ uid: 
+ rid: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_intervaltree_destroy ##### -->
+<para>
+
+</para>
+
+ tree: 
+
+
+<!-- ##### FUNCTION e_intervaltree_search ##### -->
+<para>
+
+</para>
+
+ tree: 
+ start: 
+ end: 
+ Returns: 
+
+
diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt
index 5a110ef..e374972 100644
--- a/docs/reference/camel/camel-sections.txt
+++ b/docs/reference/camel/camel-sections.txt
@@ -2300,6 +2300,8 @@ camel_stream_vfs_get_type
 <FILE>camel-tcp-stream-raw</FILE>
 <TITLE>CamelTcpStreamRaw</TITLE>
 CamelTcpStreamRaw
+CAMEL_PROXY_ERROR
+CamelProxyError
 camel_tcp_stream_raw_new
 <SUBSECTION Standard>
 CAMEL_TCP_STREAM_RAW
@@ -2314,6 +2316,7 @@ addrinfo
 sockaddr
 socklen_t
 camel_tcp_stream_raw_get_type
+camel_proxy_error_quark
 </SECTION>
 
 <SECTION>
@@ -2349,6 +2352,7 @@ CamelSockOptData
 camel_tcp_stream_connect
 camel_tcp_stream_getsockopt
 camel_tcp_stream_setsockopt
+camel_tcp_stream_get_file_desc
 camel_tcp_stream_set_socks_proxy
 camel_tcp_stream_peek_socks_proxy
 camel_tcp_stream_get_local_address
diff --git a/docs/reference/camel/tmpl/camel-cipher-context.sgml b/docs/reference/camel/tmpl/camel-cipher-context.sgml
index 94b1ca7..0546cfe 100644
--- a/docs/reference/camel/tmpl/camel-cipher-context.sgml
+++ b/docs/reference/camel/tmpl/camel-cipher-context.sgml
@@ -466,6 +466,12 @@ CamelCipherContext
 @gpointer cert_data: 
 @gpointer cert_data:
 @gpointer cert_data: 
+ gpointer cert_data:
+ gpointer cert_data: 
+ gpointer cert_data:
+ gpointer cert_data: 
+ gpointer cert_data:
+ gpointer cert_data: 
 @gpointer cert_data: 
 
 
diff --git a/docs/reference/camel/tmpl/camel-tcp-stream-raw.sgml b/docs/reference/camel/tmpl/camel-tcp-stream-raw.sgml
index 7c49c5e..2d9abbc 100644
--- a/docs/reference/camel/tmpl/camel-tcp-stream-raw.sgml
+++ b/docs/reference/camel/tmpl/camel-tcp-stream-raw.sgml
@@ -26,6 +26,21 @@ CamelTcpStreamRaw
 </para>
 
 
+<!-- ##### MACRO CAMEL_PROXY_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM CamelProxyError ##### -->
+<para>
+
+</para>
+
+ CAMEL_PROXY_ERROR_PROXY_NOT_SUPPORTED: 
+ CAMEL_PROXY_ERROR_CANT_AUTHENTICATE: 
+
 <!-- ##### FUNCTION camel_tcp_stream_raw_new ##### -->
 <para>
 
diff --git a/docs/reference/camel/tmpl/camel-tcp-stream.sgml b/docs/reference/camel/tmpl/camel-tcp-stream.sgml
index 110f656..b15841d 100644
--- a/docs/reference/camel/tmpl/camel-tcp-stream.sgml
+++ b/docs/reference/camel/tmpl/camel-tcp-stream.sgml
@@ -95,6 +95,15 @@ CamelTcpStream
 @Returns: 
 
 
+<!-- ##### FUNCTION camel_tcp_stream_get_file_desc ##### -->
+<para>
+
+</para>
+
+ stream: 
+ Returns: 
+
+
 <!-- ##### FUNCTION camel_tcp_stream_set_socks_proxy ##### -->
 <para>
 
diff --git a/docs/reference/libedataserver/libedataserver-docs.sgml b/docs/reference/libedataserver/libedataserver-docs.sgml
index 4b7094d..88b83d6 100644
--- a/docs/reference/libedataserver/libedataserver-docs.sgml
+++ b/docs/reference/libedataserver/libedataserver-docs.sgml
@@ -13,6 +13,7 @@
     <xi:include href="xml/e-account.xml"/>
     <xi:include href="xml/e-account-list.xml"/>
     <xi:include href="xml/e-categories.xml"/>
+    <xi:include href="xml/e-debug-log.xml"/>
     <xi:include href="xml/e-flag.xml"/>
     <xi:include href="xml/e-iterator.xml"/>
     <xi:include href="xml/e-list.xml"/>
diff --git a/docs/reference/libedataserver/libedataserver-sections.txt b/docs/reference/libedataserver/libedataserver-sections.txt
index 425f1ea..3d988b1 100644
--- a/docs/reference/libedataserver/libedataserver-sections.txt
+++ b/docs/reference/libedataserver/libedataserver-sections.txt
@@ -62,6 +62,25 @@ e_account_list_get_type
 </SECTION>
 
 <SECTION>
+<FILE>e-debug-log</FILE>
+<TITLE>e-debug-log</TITLE>
+E_DEBUG_LOG_DOMAIN_USER
+E_DEBUG_LOG_DOMAIN_GLOG
+E_DEBUG_LOG_DOMAIN_CAL_QUERIES
+e_debug_log
+e_debug_logv
+e_debug_log_load_configuration
+e_debug_log_enable_domains
+e_debug_log_disable_domains
+e_debug_log_is_domain_enabled
+e_debug_log_dump
+e_debug_log_dump_to_dated_file
+e_debug_log_set_max_lines
+e_debug_log_get_max_lines
+e_debug_log_clear
+</SECTION>
+
+<SECTION>
 <FILE>e-flag</FILE>
 <TITLE>EFlag</TITLE>
 EFlag
@@ -341,6 +360,7 @@ e_sexp_encode_string
 e_sexp_fatal_error
 e_sexp_error
 e_sexp_parse_value
+e_sexp_evaluate_occur_times
 <SUBSECTION Standard>
 E_TYPE_SEXP
 E_SEXP
diff --git a/docs/reference/libedataserver/tmpl/e-debug-log.sgml b/docs/reference/libedataserver/tmpl/e-debug-log.sgml
new file mode 100644
index 0000000..13acebb
--- /dev/null
+++ b/docs/reference/libedataserver/tmpl/e-debug-log.sgml
@@ -0,0 +1,146 @@
+<!-- ##### SECTION Title ##### -->
+e-debug-log
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
+<!-- ##### MACRO E_DEBUG_LOG_DOMAIN_USER ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_DEBUG_LOG_DOMAIN_GLOG ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO E_DEBUG_LOG_DOMAIN_CAL_QUERIES ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION e_debug_log ##### -->
+<para>
+
+</para>
+
+ is_milestone: 
+ domain: 
+ format: 
+ Varargs: 
+
+
+<!-- ##### FUNCTION e_debug_logv ##### -->
+<para>
+
+</para>
+
+ is_milestone: 
+ domain: 
+ format: 
+ args: 
+
+
+<!-- ##### FUNCTION e_debug_log_load_configuration ##### -->
+<para>
+
+</para>
+
+ filename: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_debug_log_enable_domains ##### -->
+<para>
+
+</para>
+
+ domains: 
+ n_domains: 
+
+
+<!-- ##### FUNCTION e_debug_log_disable_domains ##### -->
+<para>
+
+</para>
+
+ domains: 
+ n_domains: 
+
+
+<!-- ##### FUNCTION e_debug_log_is_domain_enabled ##### -->
+<para>
+
+</para>
+
+ domain: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_debug_log_dump ##### -->
+<para>
+
+</para>
+
+ filename: 
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_debug_log_dump_to_dated_file ##### -->
+<para>
+
+</para>
+
+ error: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_debug_log_set_max_lines ##### -->
+<para>
+
+</para>
+
+ num_lines: 
+
+
+<!-- ##### FUNCTION e_debug_log_get_max_lines ##### -->
+<para>
+
+</para>
+
+ void: 
+ Returns: 
+
+
+<!-- ##### FUNCTION e_debug_log_clear ##### -->
+<para>
+
+</para>
+
+ void: 
+
+
diff --git a/docs/reference/libedataserver/tmpl/e-sexp.sgml b/docs/reference/libedataserver/tmpl/e-sexp.sgml
index bc0316b..21fa768 100644
--- a/docs/reference/libedataserver/tmpl/e-sexp.sgml
+++ b/docs/reference/libedataserver/tmpl/e-sexp.sgml
@@ -38,6 +38,9 @@ ESExp
 </para>
 
 @type: 
+ time_generator: 
+ occuring_start: 
+ occuring_end: 
 
 <!-- ##### ENUM ESExpTermType ##### -->
 <para>
@@ -286,3 +289,14 @@ ESExp
 @Returns: 
 
 
+<!-- ##### FUNCTION e_sexp_evaluate_occur_times ##### -->
+<para>
+
+</para>
+
+ f: 
+ start: 
+ end: 
+ Returns: 
+
+
diff --git a/libedataserver/e-debug-log.c b/libedataserver/e-debug-log.c
index 38bcb5a..1f67bb7 100644
--- a/libedataserver/e-debug-log.c
+++ b/libedataserver/e-debug-log.c
@@ -58,6 +58,11 @@ unlock (void)
 	g_static_mutex_unlock (&log_mutex);
 }
 
+/**
+ * e_debug_log:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_log (gboolean is_milestone, const gchar *domain, const gchar *format, ...)
 {
@@ -137,6 +142,11 @@ add_to_milestones (const gchar *str)
 	g_assert (milestones_head != NULL && milestones_tail != NULL);
 }
 
+/**
+ * e_debug_logv:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_logv (gboolean is_milestone, const gchar *domain, const gchar *format, va_list args)
 {
@@ -176,6 +186,11 @@ e_debug_logv (gboolean is_milestone, const gchar *domain, const gchar *format, v
 	unlock ();
 }
 
+/**
+ * e_debug_log_load_configuration:
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_debug_log_load_configuration (const gchar *filename, GError **error)
 {
@@ -224,6 +239,11 @@ e_debug_log_load_configuration (const gchar *filename, GError **error)
 	return TRUE;
 }
 
+/**
+ * e_debug_log_enable_domains:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_log_enable_domains (const gchar **domains, gint n_domains)
 {
@@ -254,6 +274,11 @@ e_debug_log_enable_domains (const gchar **domains, gint n_domains)
 	unlock ();
 }
 
+/**
+ * e_debug_log_disable_domains:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_log_disable_domains (const gchar **domains, gint n_domains)
 {
@@ -284,6 +309,11 @@ e_debug_log_disable_domains (const gchar **domains, gint n_domains)
 	unlock ();
 }
 
+/**
+ * e_debug_log_is_domain_enabled:
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_debug_log_is_domain_enabled (const gchar *domain)
 {
@@ -456,6 +486,11 @@ dump_ring_buffer (const gchar *filename, FILE *file, GError **error)
 	return TRUE;
 }
 
+/**
+ * e_debug_log_dump:
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_debug_log_dump (const gchar *filename, GError **error)
 {
@@ -513,6 +548,11 @@ e_debug_log_dump (const gchar *filename, GError **error)
 	return success;
 }
 
+/**
+ * e_debug_log_dump_to_dated_file:
+ *
+ * Since: 2.32
+ **/
 gboolean
 e_debug_log_dump_to_dated_file (GError **error)
 {
@@ -544,6 +584,11 @@ e_debug_log_dump_to_dated_file (GError **error)
 	return retval;
 }
 
+/**
+ * e_debug_log_set_max_lines:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_log_set_max_lines (gint num_lines)
 {
@@ -597,6 +642,11 @@ e_debug_log_set_max_lines (gint num_lines)
 	unlock ();
 }
 
+/**
+ * e_debug_log_get_max_lines:
+ *
+ * Since: 2.32
+ **/
 gint
 e_debug_log_get_max_lines (void)
 {
@@ -609,6 +659,11 @@ e_debug_log_get_max_lines (void)
 	return retval;
 }
 
+/**
+ * e_debug_log_clear:
+ *
+ * Since: 2.32
+ **/
 void
 e_debug_log_clear (void)
 {
diff --git a/libedataserver/e-debug-log.h b/libedataserver/e-debug-log.h
index 753aa99..374b24f 100644
--- a/libedataserver/e-debug-log.h
+++ b/libedataserver/e-debug-log.h
@@ -27,8 +27,25 @@
 
 #include <glib.h>
 
+/**
+ * E_DEBUG_LOG_DOMAIN_USER:
+ *
+ * Since: 2.32
+ **/
 #define E_DEBUG_LOG_DOMAIN_USER		"USER"		/* always enabled */
+
+/**
+ * E_DEBUG_LOG_DOMAIN_GLOG:
+ *
+ * Since: 2.32
+ **/
 #define E_DEBUG_LOG_DOMAIN_GLOG		"GLog"		/* used for GLog messages; don't use it yourself */
+
+/**
+ * E_DEBUG_LOG_DOMAIN_CAL_QUERIES:
+ *
+ * Since: 2.32
+ **/
 #define E_DEBUG_LOG_DOMAIN_CAL_QUERIES  "CalQueries"    /* used for calendar queries analysis */
 
 void e_debug_log (gboolean is_milestone, const gchar *domain, const gchar *format, ...);
diff --git a/libedataserver/e-sexp.c b/libedataserver/e-sexp.c
index 5a4a030..de82ccc 100644
--- a/libedataserver/e-sexp.c
+++ b/libedataserver/e-sexp.c
@@ -1556,6 +1556,7 @@ e_sexp_eval(ESExp *f)
  *
  * Determines biggest time window given by expressions "occur-in-range" in sexp.
  *
+ * Since: 2.32
  */
 gboolean
 e_sexp_evaluate_occur_times(ESExp *f, time_t *start, time_t *end)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]