summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSeif Lotfy <seif@lotfy.com>2013-04-11 15:49:31 +0200
committerSeif Lotfy <seif@lotfy.com>2013-04-11 15:49:31 +0200
commit30ff0df89966e83da2388b4c02c239c0c3272f23 (patch)
tree0de708751e793e5df8241a5af416174fa1882184
parent92569fcfb1687b565dd2a8fd00cbd1e94634b6ee (diff)
downloadzeitgeist-30ff0df89966e83da2388b4c02c239c0c3272f23.tar.gz
Fix documentation so the c html is generated
-rw-r--r--libzeitgeist/data-source-registry.vala10
-rw-r--r--libzeitgeist/data-source.vala25
-rw-r--r--libzeitgeist/log.vala2
-rw-r--r--libzeitgeist/utils.vala3
4 files changed, 32 insertions, 8 deletions
diff --git a/libzeitgeist/data-source-registry.vala b/libzeitgeist/data-source-registry.vala
index 15582783..8dfd9d21 100644
--- a/libzeitgeist/data-source-registry.vala
+++ b/libzeitgeist/data-source-registry.vala
@@ -1,5 +1,4 @@
-/* data-source-registry.vala
- *
+/*
* Copyright © 2012 Collabora Ltd.
* By Siegfried-Angel Gevatter Pujals <siegfried@gevatter.com>
*
@@ -47,7 +46,14 @@ namespace Zeitgeist
/**
* Query the Zeitgeist Data-Source Registry extension
+ *
+ * The Zeitgeist engine maintains a publicly available list of recognized
+ * data-sources (components inserting information into Zeitgeist).
+ * ZeitgeistDataSourceRegistry is used to register new data sources,
+ * get information about them and gives the ability to enable or disable
+ * the data sources.
*/
+
public class DataSourceRegistry : QueuedProxyWrapper
{
diff --git a/libzeitgeist/data-source.vala b/libzeitgeist/data-source.vala
index d398e2ca..edaf94e1 100644
--- a/libzeitgeist/data-source.vala
+++ b/libzeitgeist/data-source.vala
@@ -1,5 +1,4 @@
-/* data-source.vala
- *
+/*
* Copyright © 2011 Michal Hruby <michal.mhr@gmail.com>
* Copyright © 2011-2012 Collabora Ltd.
* By Siegfried-Angel Gevatter Pujals <siegfried@gevatter.com>
@@ -20,11 +19,18 @@
*/
/**
- * Abstracts data sources used by the Data-Source Registry extension
+ * Abstracts data sources used by the DataSourceRegistry extension
+ *
+ * ZeitgeistDataSource represents a data source used to insert events into
+ * Zeitgeist. The data sources are identified using the unique_id property,
+ * and when querying the data source registry you get other interesting
+ * information like timestamp of the last action of the data source, flag
+ * whether it is currently running etc.
*/
namespace Zeitgeist
{
+
public class DataSource: Object
{
public string unique_id { get; set; }
@@ -36,7 +42,18 @@ namespace Zeitgeist
public bool enabled { get; set; }
public bool running { get; set; }
public int64 timestamp { get; set; }
-
+ /**
+ * ZeitgeistDataSource
+ *
+ * Abstracts data sources used by the ZeitgeistDataSourceRegistry extension
+ *
+ * ZeitgeistDataSource represents a data source used to insert events into
+ * Zeitgeist. The data sources are identified using the unique_id property,
+ * and when querying the data source registry you get other interesting
+ * information like timestamp of the last action of the data source, flag
+ * whether it is currently running etc.
+ *
+ */
public DataSource ()
{
Object ();
diff --git a/libzeitgeist/log.vala b/libzeitgeist/log.vala
index 890d3077..966624bc 100644
--- a/libzeitgeist/log.vala
+++ b/libzeitgeist/log.vala
@@ -425,8 +425,6 @@ public class Log : QueuedProxyWrapper
}
/**
- * Warning: This API is EXPERIMENTAL and is not fully supported yet.
- *
* Get a list of URIs of subjects which frequently occur together with events
* matching event_templates. Possibly restricting to time_range or to URIs
* that occur as subject of events matching result_event_templates.
diff --git a/libzeitgeist/utils.vala b/libzeitgeist/utils.vala
index 61e0b1b8..0446bba6 100644
--- a/libzeitgeist/utils.vala
+++ b/libzeitgeist/utils.vala
@@ -26,6 +26,9 @@ namespace Zeitgeist
{
/**
* Utility functions. FOR INTERNAL USE ONLY
+ *
+ * A set of funtions that if used would only affect libzeitgeist in the
+ * code it is used in.
*/
namespace Utils
{