From 0c157c1577925181934b2a2a453f280a9e92c6cd Mon Sep 17 00:00:00 2001 From: Siegfried-Angel Gevatter Pujals Date: Wed, 7 Nov 2012 23:16:44 +0100 Subject: Documentation and autotools fixes - Added a custom index page for the C documentation - Removed duplicate Vala documentation - Added missing documentation, titles, fixed links, etc. - Fixed autotools to updated the docs whenever needed - Fixed autotools to update the ontology files whenever needed - Updated AUTHORS, added content to README --- libzeitgeist/Makefile.am | 8 ++++++-- libzeitgeist/data-source-registry.vala | 9 ++++----- libzeitgeist/event.vala | 2 +- libzeitgeist/log.vala | 19 +++++++++++++++++-- libzeitgeist/monitor.vala | 11 ++++------- libzeitgeist/ontology-uris.vala.in | 2 +- libzeitgeist/remote.vala | 10 +++++----- libzeitgeist/subject.vala | 7 +++++++ libzeitgeist/timerange.vala | 3 +++ libzeitgeist/utils.vala | 2 +- 10 files changed, 49 insertions(+), 24 deletions(-) (limited to 'libzeitgeist') diff --git a/libzeitgeist/Makefile.am b/libzeitgeist/Makefile.am index 15fc9941..884006d0 100644 --- a/libzeitgeist/Makefile.am +++ b/libzeitgeist/Makefile.am @@ -2,6 +2,10 @@ NULL = lib_LTLIBRARIES = libzeitgeist-2.0.la +ONTOLOGY = \ + $(wildcard $(top_srcdir)/data/ontology/*.trig) \ + $(NULL) + AM_CPPFLAGS = \ $(ZEITGEIST_CFLAGS) \ -include $(CONFIG_HEADER) \ @@ -67,8 +71,8 @@ DISTCLEANFILES = \ zeitgeist-2.0.vapi \ $(NULL) -# FIXME: can we make this depend on $(ontology_trig_DATA)? -ontology_vala.stamp: ontology.vala.in ontology-uris.vala.in +ontology_vala.stamp: ontology.vala.in ontology-uris.vala.in \ + $(ONTOLOGY) $(top_srcdir)/data/ontology2code $(AM_V_GEN)$(top_srcdir)/data/ontology2code --vala @touch "$@" diff --git a/libzeitgeist/data-source-registry.vala b/libzeitgeist/data-source-registry.vala index dbebcc3a..f3831655 100644 --- a/libzeitgeist/data-source-registry.vala +++ b/libzeitgeist/data-source-registry.vala @@ -18,15 +18,11 @@ * */ -/** - * Query the Zeitgeist Data-Source Registry extension - */ - namespace Zeitgeist { [DBus (name = "org.gnome.zeitgeist.DataSourceRegistry")] - public interface RemoteRegistry: Object + protected interface RemoteRegistry: Object { [DBus (signature = "a(sssa(asaasay)bxb)")] public abstract async Variant get_data_sources ( @@ -49,6 +45,9 @@ namespace Zeitgeist [DBus (signature = "(sssa(asaasay)bxb)")] Variant data_source); } + /** + * Query the Zeitgeist Data-Source Registry extension + */ public class DataSourceRegistry : QueuedProxyWrapper { diff --git a/libzeitgeist/event.vala b/libzeitgeist/event.vala index d77a9edb..9112c3d7 100644 --- a/libzeitgeist/event.vala +++ b/libzeitgeist/event.vala @@ -72,7 +72,7 @@ private bool check_field_match (string? property, } /** - * #Event objects abstract Zeitgeist events. + * #Event objects abstract Zeitgeist events * * The #Event class is one of the primary elements for communicating * with the Zeitgeist daemon. #Events serve two purposes diff --git a/libzeitgeist/log.vala b/libzeitgeist/log.vala index 437cdd48..693b941c 100644 --- a/libzeitgeist/log.vala +++ b/libzeitgeist/log.vala @@ -21,14 +21,29 @@ * */ +/** + * Zeitgeist is an activity-logging framework to enable the desktop of + * the future. + * + * Its main component is the Zeitgeist engine, a D-Bus service that logs + * any events other applications send to it. An event may be anything like: + * - The user opened/created/modified/closed a file, or visited a website. + * - The user received an e-mail, a phone call or an IM notification. + * - Someone modified a remote (eg. Google Drive) document owned by the user. + * + * This information is then made available to other Zeitgeist-enabled + * applications over a powerful querying and monitoring API, and can be used + * and analyzed to create intelligent or adaptive interfaces. + * + * Zeitgeist also comes with a blacklist extension to make sure the user + * always stays in control of what information is logged. + */ namespace Zeitgeist { /** * Primary access point for talking to the Zeitgeist daemon * - * include: zeitgeist.h - * * #ZeitgeistLog encapsulates the low level access to the Zeitgeist daemon. * You can use it to manage the log by inserting and deleting entries as well * as do queries on the logged data. diff --git a/libzeitgeist/monitor.vala b/libzeitgeist/monitor.vala index f6b783f7..5a2b898a 100644 --- a/libzeitgeist/monitor.vala +++ b/libzeitgeist/monitor.vala @@ -20,12 +20,13 @@ * */ +namespace Zeitgeist +{ + /** * Listens for updates to the Zeitgeist event log * - * include: zeitgeist.h - * - * A #ZeitgeistMonitor listens for updates to the Zeitgeist event log + * A #Monitor listens for updates to the Zeitgeist event log * matching a given set of templates and with timestamps in some predefined * time range. * @@ -33,10 +34,6 @@ * zeitgeist_log_install_monitor(). The monitor will not emit any of the * ::events-added or ::events-deleted signals before this. */ - -namespace Zeitgeist -{ - public class Monitor : Object, RemoteMonitor { diff --git a/libzeitgeist/ontology-uris.vala.in b/libzeitgeist/ontology-uris.vala.in index 79ca408c..cbcb8098 100644 --- a/libzeitgeist/ontology-uris.vala.in +++ b/libzeitgeist/ontology-uris.vala.in @@ -1,6 +1,6 @@ /* ontology-uris.vala * - * Copyright © 2009-2011 The Zeitgeist Team + * Copyright © 2009-2012 The Zeitgeist Team * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by diff --git a/libzeitgeist/remote.vala b/libzeitgeist/remote.vala index 979e6866..cccaa7ec 100644 --- a/libzeitgeist/remote.vala +++ b/libzeitgeist/remote.vala @@ -29,7 +29,7 @@ namespace Zeitgeist } [DBus (name = "org.gnome.zeitgeist.Log")] - public interface RemoteLog : Object + protected interface RemoteLog : Object { [DBus (signature = "(xx)")] @@ -100,7 +100,7 @@ namespace Zeitgeist } [DBus (name = "org.gnome.zeitgeist.Monitor")] - public interface RemoteMonitor : Object + protected interface RemoteMonitor : Object { public async abstract void notify_insert ( @@ -116,7 +116,7 @@ namespace Zeitgeist } [DBus (name = "org.gnome.zeitgeist.Index")] - public interface RemoteSimpleIndexer : Object + protected interface RemoteSimpleIndexer : Object { public abstract async void search ( string query_string, @@ -138,7 +138,7 @@ namespace Zeitgeist /* FIXME: Remove this! Only here because of a bug in Vala (Vala Bug #661361) */ [DBus (name = "org.freedesktop.NetworkManager")] - public interface NetworkManagerDBus : Object + protected interface NetworkManagerDBus : Object { [DBus (name = "state")] public abstract uint32 state () throws IOError; @@ -148,7 +148,7 @@ namespace Zeitgeist /* FIXME: Remove this! Only here because of a bug in Vala (Vala Bug #661361) */ [DBus (name = "net.connman.Manager")] - public interface ConnmanManagerDBus : Object + protected interface ConnmanManagerDBus : Object { public abstract string get_state () throws IOError; public signal void state_changed (string state); diff --git a/libzeitgeist/subject.vala b/libzeitgeist/subject.vala index 03de54c9..b6536b86 100644 --- a/libzeitgeist/subject.vala +++ b/libzeitgeist/subject.vala @@ -28,6 +28,13 @@ using Zeitgeist; namespace Zeitgeist { +/** + * Subject objects abstract Zeitgeist subjects + * + * In Zeitgeist terminology, a //subject// is something (a file, web page, + * person, conversation, etc.) that was somehow involved or affected by + * a {@link Event}. + */ public class Subject : Object { private static StringChunk url_store; diff --git a/libzeitgeist/timerange.vala b/libzeitgeist/timerange.vala index c9bf9842..4b0a6c54 100644 --- a/libzeitgeist/timerange.vala +++ b/libzeitgeist/timerange.vala @@ -28,6 +28,9 @@ namespace Zeitgeist { /** + * Immutable representation of an interval in time, marked by a + * beginning and an end + * * A light, immutable, encapsulation of an interval in time, marked by * a beginning and an end. */ diff --git a/libzeitgeist/utils.vala b/libzeitgeist/utils.vala index 4534973e..31141982 100644 --- a/libzeitgeist/utils.vala +++ b/libzeitgeist/utils.vala @@ -194,7 +194,7 @@ namespace Zeitgeist * * @param s string to check */ - internal bool is_empty_string (string? s) + public bool is_empty_string (string? s) { return s == null || s == ""; } -- cgit v1.2.1