summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Dufresne <nicolas.dufresne@collabora.com>2012-08-28 15:56:51 -0400
committerNicolas Dufresne <nicolas.dufresne@collabora.com>2012-08-28 15:56:51 -0400
commit0361c0f908c20b6dacf8eb765cf1db546b74939a (patch)
tree46982846066593e9ee01ea2b152bb33e8dc6873e
parent7f3d4a9a978265e5e1e43e258a9657851ee05cdf (diff)
downloadtelepathy-logger-0361c0f908c20b6dacf8eb765cf1db546b74939a.tar.gz
Documentation fix
-rw-r--r--doc/reference/libtelepathy-logger/Makefile.am4
-rw-r--r--doc/reference/libtelepathy-logger/docs.xml2
-rw-r--r--telepathy-logger/log-manager-internal.h4
-rw-r--r--telepathy-logger/log-manager.c11
-rw-r--r--telepathy-logger/log-manager.h9
-rw-r--r--telepathy-logger/log-store.c2
-rw-r--r--telepathy-logger/observer.c2
7 files changed, 22 insertions, 12 deletions
diff --git a/doc/reference/libtelepathy-logger/Makefile.am b/doc/reference/libtelepathy-logger/Makefile.am
index 5ea7c96..e9380b7 100644
--- a/doc/reference/libtelepathy-logger/Makefile.am
+++ b/doc/reference/libtelepathy-logger/Makefile.am
@@ -57,8 +57,11 @@ CFILE_GLOB=$(top_srcdir)/telepathy-logger/*.c
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=\
action-chain-internal.h \
+ call-channel-internal.h \
+ call-event-internal.h \
channel-factory-internal.h \
channel-internal.h \
+ client-factory-internal.h \
conf-internal.h \
contact-internal.h \
dbus-service-internal.h \
@@ -68,6 +71,7 @@ IGNORE_HFILES=\
log-iter-pidgin-internal.h \
log-iter-xml-internal.h \
log-manager-internal.h \
+ log-store.c \
log-store-factory-internal.h \
log-store-internal.h \
log-store-sqlite-internal.h \
diff --git a/doc/reference/libtelepathy-logger/docs.xml b/doc/reference/libtelepathy-logger/docs.xml
index 64642f0..b75ad88 100644
--- a/doc/reference/libtelepathy-logger/docs.xml
+++ b/doc/reference/libtelepathy-logger/docs.xml
@@ -9,10 +9,12 @@
<chapter id="ch-public">
<title>libtelepathy-logger API</title>
+ <xi:include href="xml/annotation-glossary.xml"/>
<xi:include href="xml/log-manager.xml"/>
<xi:include href="xml/log-walker.xml"/>
<xi:include href="xml/event.xml"/>
<xi:include href="xml/text-event.xml"/>
+ <xi:include href="xml/call-event.xml"/>
<xi:include href="xml/entity.xml"/>
</chapter>
diff --git a/telepathy-logger/log-manager-internal.h b/telepathy-logger/log-manager-internal.h
index 4a60d90..56650de 100644
--- a/telepathy-logger/log-manager-internal.h
+++ b/telepathy-logger/log-manager-internal.h
@@ -26,6 +26,8 @@
#include <telepathy-logger/log-store-factory-internal.h>
#include <telepathy-logger/log-store-internal.h>
+#define TPL_TYPE_LOG_SEARCH_HIT (_tpl_log_manager_search_hit_get_type ())
+
gboolean _tpl_log_manager_add_event (TplLogManager *manager,
TplEvent *event,
GError **error);
@@ -66,6 +68,8 @@ void _tpl_log_manager_clear_account (TplLogManager *self, TpAccount *account);
void _tpl_log_manager_clear_entity (TplLogManager *self, TpAccount *account,
TplEntity *entity);
+GType _tpl_log_manager_search_hit_get_type (void);
+
TplLogSearchHit * _tpl_log_manager_search_hit_new (TpAccount *account,
TplEntity *target,
GDate *date);
diff --git a/telepathy-logger/log-manager.c b/telepathy-logger/log-manager.c
index 5a11c6e..642e3f9 100644
--- a/telepathy-logger/log-manager.c
+++ b/telepathy-logger/log-manager.c
@@ -118,6 +118,7 @@ typedef struct
G_DEFINE_TYPE (TplLogManager, tpl_log_manager, G_TYPE_OBJECT);
+
G_DEFINE_BOXED_TYPE (TplLogSearchHit,
_tpl_log_manager_search_hit,
_tpl_log_manager_search_hit_copy,
@@ -324,7 +325,7 @@ tpl_log_manager_dup_singleton (void)
* @error: the memory location of GError, filled if an error occurs
*
* It stores @event, sending it to all the registered TplLogStore which have
- * #TplLogStore:writable set to %TRUE.
+ * TplLogStore:writable set to %TRUE.
* Every TplLogManager is guaranteed to have at least a readable
* and a writable TplLogStore regitered.
*
@@ -397,7 +398,7 @@ _tpl_log_manager_add_event (TplLogManager *manager,
* #TplLogStore:writable is set to %TRUE.
*
* @logstore has to properly implement all the search/query methods if the
- * #TplLogStore:readable is set to %TRUE.
+ * TplLogStore:readable is set to %TRUE.
*/
gboolean
_tpl_log_manager_register_log_store (TplLogManager *self,
@@ -452,7 +453,7 @@ _tpl_log_manager_register_log_store (TplLogManager *self,
*
* Checks if logs exist for @target.
*
- * It applies for any registered TplLogStore with the #TplLogStore:readable
+ * It applies for any registered TplLogStore with the TplLogStore:readable
* property %TRUE.
* Returns: %TRUE logs exist for @target, otherwise %FALSE
@@ -491,7 +492,7 @@ tpl_log_manager_exists (TplLogManager *manager,
* Retrieves a list of #GDate corresponding to each day
* at least an event exist for @target_id.
*
- * It applies for any registered TplLogStore with the #TplLogStore:readable
+ * It applies for any registered TplLogStore with the TplLogStore:readable
* property %TRUE.
*
* Returns: a GList of (GDate *), to be freed using something like
@@ -891,7 +892,7 @@ _get_dates_async_thread (GSimpleAsyncResult *simple,
* Retrieves a list of #GDate corresponding to each day where
* at least one event exist for @target.
*
- * It applies for any registered TplLogStore with the #TplLogStore:readable
+ * It applies for any registered TplLogStore with the TplLogStore:readable
* property %TRUE.
*/
void
diff --git a/telepathy-logger/log-manager.h b/telepathy-logger/log-manager.h
index 2bc8fa8..bd5e610 100644
--- a/telepathy-logger/log-manager.h
+++ b/telepathy-logger/log-manager.h
@@ -31,7 +31,6 @@
G_BEGIN_DECLS
#define TPL_TYPE_LOG_MANAGER (tpl_log_manager_get_type ())
-#define TPL_TYPE_LOG_SEARCH_HIT (_tpl_log_manager_search_hit_get_type ())
#define TPL_LOG_MANAGER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), TPL_TYPE_LOG_MANAGER, TplLogManager))
#define TPL_LOG_MANAGER_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), TPL_TYPE_LOG_MANAGER, TplLogManagerClass))
#define TPL_IS_LOG_MANAGER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), TPL_TYPE_LOG_MANAGER))
@@ -68,6 +67,7 @@ typedef struct
/**
* TplEventTypeMask:
* @TPL_EVENT_MASK_TEXT: Mask to #TplTextEvent
+ * @TPL_EVENT_MASK_CALL: Mask to #TplCallEvent
* @TPL_EVENT_MASK_ANY: Special value to select all type of #TplEvent
*
* Mask used to filter type of #TplEvent returned.
@@ -79,7 +79,6 @@ typedef enum
TPL_EVENT_MASK_ANY = 0xffff
} TplEventTypeMask;
-
/**
* TplLogSearchHit:
* @account: the #TpAccount
@@ -88,18 +87,18 @@ typedef enum
*
* Represent the context where the search has results.
*/
-typedef struct
+typedef struct _TplLogSearchHit TplLogSearchHit;
+struct _TplLogSearchHit
{
TpAccount *account;
TplEntity *target;
GDate *date;
-} TplLogSearchHit;
+};
typedef gboolean (*TplLogEventFilter) (TplEvent *event,
gpointer user_data);
GType tpl_log_manager_get_type (void);
-GType _tpl_log_manager_search_hit_get_type (void);
TplLogManager *tpl_log_manager_dup_singleton (void);
diff --git a/telepathy-logger/log-store.c b/telepathy-logger/log-store.c
index 73f0fd6..f57645e 100644
--- a/telepathy-logger/log-store.c
+++ b/telepathy-logger/log-store.c
@@ -26,7 +26,7 @@
#define DEBUG_FLAG TPL_DEBUG_LOG_STORE
#include <telepathy-logger/debug-internal.h>
-/**
+/*
* SECTION:log-store
* @title: TplLogStore
* @short_description: LogStore interface can register into #TplLogManager as
diff --git a/telepathy-logger/observer.c b/telepathy-logger/observer.c
index 9c3bd9c..ff9a07b 100644
--- a/telepathy-logger/observer.c
+++ b/telepathy-logger/observer.c
@@ -33,7 +33,7 @@
#include <telepathy-logger/debug-internal.h>
#include <telepathy-logger/util-internal.h>
-/**
+/*
* SECTION:observer
* @title: TplObserver
* @short_description: TPL Observer main class, used to handle received