[folks] Bug 626008 — Add @since lines to all symbols
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [folks] Bug 626008 — Add @since lines to all symbols
- Date: Mon, 13 Sep 2010 12:29:22 +0000 (UTC)
commit 002a9585e7a13062d958dec2fac86e9fa060627c
Author: Philip Withnall <philip withnall collabora co uk>
Date: Mon Sep 13 13:28:14 2010 +0100
Bug 626008 â?? Add @since lines to all symbols
Add @since lines to the documentation of all symbols which were added after
the initial release (0.1.9). Closes: bgo#626008
backends/key-file/kf-backend.vala | 2 ++
backends/key-file/kf-persona-store.vala | 2 ++
backends/key-file/kf-persona.vala | 2 ++
folks/backend.vala | 2 ++
folks/groups.vala | 2 ++
folks/imable.vala | 4 ++++
folks/individual-aggregator.vala | 6 ++++++
folks/individual.vala | 2 ++
folks/persona-store.vala | 14 ++++++++++++++
folks/persona.vala | 7 +++++++
folks/presence.vala | 1 +
11 files changed, 44 insertions(+), 0 deletions(-)
---
diff --git a/backends/key-file/kf-backend.vala b/backends/key-file/kf-backend.vala
index 1fd3961..ec935e5 100644
--- a/backends/key-file/kf-backend.vala
+++ b/backends/key-file/kf-backend.vala
@@ -26,6 +26,8 @@ using Folks.Backends.Kf;
* A backend which loads { link Persona}s from a simple key file in
* (XDG_DATA_HOME/folks/) and presents them through a single
* { link PersonaStore}.
+ *
+ * @since 0.1.13
*/
public class Folks.Backends.Kf.Backend : Folks.Backend
{
diff --git a/backends/key-file/kf-persona-store.vala b/backends/key-file/kf-persona-store.vala
index 153810e..9f2490a 100644
--- a/backends/key-file/kf-persona-store.vala
+++ b/backends/key-file/kf-persona-store.vala
@@ -26,6 +26,8 @@ using Folks.Backends.Kf;
/**
* A persona store which is associated with a single simple key file. It will
* create a { link Persona} for each of the groups in the key file.
+ *
+ * @since 0.1.13
*/
public class Folks.Backends.Kf.PersonaStore : Folks.PersonaStore
{
diff --git a/backends/key-file/kf-persona.vala b/backends/key-file/kf-persona.vala
index 372451c..6e64bfc 100644
--- a/backends/key-file/kf-persona.vala
+++ b/backends/key-file/kf-persona.vala
@@ -25,6 +25,8 @@ using Folks.Backends.Kf;
/**
* A persona subclass which represents a single persona from a simple key file.
+ *
+ * @since 0.1.13
*/
public class Folks.Backends.Kf.Persona : Folks.Persona,
Alias,
diff --git a/folks/backend.vala b/folks/backend.vala
index 0bdb419..ca68d17 100644
--- a/folks/backend.vala
+++ b/folks/backend.vala
@@ -91,6 +91,8 @@ public abstract class Folks.Backend : Object
* This is normally handled transparently by the { link IndividualAggregator}.
*
* If this function throws an error, the Backend will not be functional.
+ *
+ * @since 0.1.11
*/
public abstract async void prepare () throws GLib.Error;
diff --git a/folks/groups.vala b/folks/groups.vala
index 74b9b09..617dfe2 100644
--- a/folks/groups.vala
+++ b/folks/groups.vala
@@ -104,6 +104,7 @@ public interface Folks.Groups : Object
*
* @param group a freeform group identifier
* @param is_member whether the contact should be a member of the group
+ * @since 0.1.11
*/
public async abstract void change_group (string group, bool is_member)
throws GLib.Error;
@@ -116,6 +117,7 @@ public interface Folks.Groups : Object
*
* @param group a freeform group identifier for the group being left or joined
* @param is_member whether the contact is joining or leaving the group
+ * @since 0.1.11
*/
public async signal void group_changed (string group, bool is_member);
}
diff --git a/folks/imable.vala b/folks/imable.vala
index c5cced5..7b7668d 100644
--- a/folks/imable.vala
+++ b/folks/imable.vala
@@ -22,6 +22,8 @@ using GLib;
/**
* IM addresses exposed by an object implementing { link Presence}.
+ *
+ * @since 0.1.13
*/
public interface Folks.IMable : Object
{
@@ -40,6 +42,8 @@ public interface Folks.IMable : Object
*
* There must be no duplicate IM addresses in each ordered set, though a given
* IM address may be present in the sets for different protocols.
+ *
+ * @since 0.1.13
*/
public abstract HashTable<string, GenericArray<string>> im_addresses
{
diff --git a/folks/individual-aggregator.vala b/folks/individual-aggregator.vala
index 26353cd..0f899f9 100644
--- a/folks/individual-aggregator.vala
+++ b/folks/individual-aggregator.vala
@@ -40,6 +40,8 @@ public errordomain Folks.IndividualAggregatorError
/**
* An operation which required the use of a writeable store failed because no
* writeable store was available.
+ *
+ * @since 0.1.13
*/
NO_WRITEABLE_STORE,
}
@@ -135,6 +137,8 @@ public class Folks.IndividualAggregator : Object
* { link IndividualAggregator.individuals_changed} signal, or a race
* condition could occur, with the signal being emitted before your code has
* connected to them, and { link Individual}s getting "lost" as a result.
+ *
+ * @since 0.1.11
*/
public async void prepare () throws GLib.Error
{
@@ -629,6 +633,7 @@ public class Folks.IndividualAggregator : Object
* backing stores.
*
* @param individual the { link Individual} to remove
+ * @since 0.1.11
*/
public async void remove_individual (Individual individual) throws GLib.Error
{
@@ -648,6 +653,7 @@ public class Folks.IndividualAggregator : Object
* This will leave other personas in the same individual alone.
*
* @param persona the { link Persona} to remove
+ * @since 0.1.11
*/
public async void remove_persona (Persona persona) throws GLib.Error
{
diff --git a/folks/individual.vala b/folks/individual.vala
index 9294ef4..54f6471 100644
--- a/folks/individual.vala
+++ b/folks/individual.vala
@@ -133,6 +133,7 @@ public class Folks.Individual : Object,
*
* @param replacement_individual the individual which has replaced this one
* due to linking, or `null` if this individual was removed for another reason
+ * @since 0.1.13
*/
public signal void removed (Individual? replacement_individual);
@@ -289,6 +290,7 @@ public class Folks.Individual : Object,
*
* @param group a freeform group identifier
* @param is_member whether the Individual should be a member of the group
+ * @since 0.1.11
*/
public async void change_group (string group, bool is_member)
{
diff --git a/folks/persona-store.vala b/folks/persona-store.vala
index 0d1a10a..e299402 100644
--- a/folks/persona-store.vala
+++ b/folks/persona-store.vala
@@ -24,6 +24,8 @@ using Folks;
/**
* Trust level for a { link PersonaStore}'s { link Persona}s for linking
* purposes.
+ *
+ * @since 0.1.13
*/
public enum Folks.PersonaStoreTrust
{
@@ -33,6 +35,8 @@ public enum Folks.PersonaStoreTrust
* This should be used for { link PersonaStore}s where even the
* { link Persona} UID could be maliciously edited to corrupt { link Persona}
* links, or where the UID changes regularly.
+ *
+ * @since 0.1.13
*/
NONE,
@@ -43,6 +47,8 @@ public enum Folks.PersonaStoreTrust
* { link PersonaStore} will not contribute towards the linking process, but
* can be linked together by their UIDs using data from { link Persona}s from
* a fully-trusted { link PersonaStore}.
+ *
+ * @since 0.1.13
*/
PARTIAL,
@@ -52,6 +58,8 @@ public enum Folks.PersonaStoreTrust
* This should only be used for user-controlled { link PersonaStore}s, as if a
* remote store is compromised, malicious changes could be made to its data
* which corrupt the user's { link Persona} links.
+ *
+ * @since 0.1.13
*/
FULL
}
@@ -161,6 +169,8 @@ public abstract class Folks.PersonaStore : Object
*
* PersonaStores must not set this property themselves; it will be set as
* appropriate by the { link IndividualAggregator}.
+ *
+ * @since 0.1.13
*/
public bool is_writeable { get; set; default = false; }
@@ -172,6 +182,7 @@ public abstract class Folks.PersonaStore : Object
* { link Persona}s for linking to produce { link Individual}s.
*
* @see PersonaStoreTrust
+ * @since 0.1.13
*/
public PersonaStoreTrust trust_level
{
@@ -190,6 +201,8 @@ public abstract class Folks.PersonaStore : Object
* This is normally handled transparently by the { link IndividualAggregator}.
*
* If this function throws an error, the PersonaStore will not be functional.
+ *
+ * @since 0.1.11
*/
public abstract async void prepare () throws GLib.Error;
@@ -238,6 +251,7 @@ public abstract class Folks.PersonaStore : Object
* { link PersonaStore.personas_changed}.
*
* @param persona the { link Persona} to remove
+ * @since 0.1.11
*/
public abstract async void remove_persona (Persona persona) throws GLib.Error;
}
diff --git a/folks/persona.vala b/folks/persona.vala
index 5a5d0a8..b74c3da 100644
--- a/folks/persona.vala
+++ b/folks/persona.vala
@@ -102,6 +102,8 @@ public abstract class Folks.Persona : Object
*
* This list will have no effect if the Persona's { link PersonaStore} trust
* level is not { link PersonaStoreTrust.FULL}.
+ *
+ * @since 0.1.13
*/
public string[] linkable_properties { get; protected set; }
@@ -113,6 +115,8 @@ public abstract class Folks.Persona : Object
* be called by the `linkable_property_to_links` implementation for each
* linkable-property-to-individual mapping it wants to add or remove in the
* aggregator.
+ *
+ * @since 0.1.13
*/
public delegate void LinkablePropertyCallback (string link);
@@ -130,6 +134,7 @@ public abstract class Folks.Persona : Object
* { link Individual} instance which contains this { link Persona}.
*
* @see Persona.linkable_properties
+ * @since 0.1.13
*/
public virtual void linkable_property_to_links (string prop_name,
LinkablePropertyCallback callback)
@@ -163,6 +168,7 @@ public abstract class Folks.Persona : Object
* @param persona_id the Persona identifier (backend-specific)
* @return a valid UID
* @see Persona.split_uid
+ * @since 0.1.13
*/
public static string build_uid (string backend_name,
string persona_store_id, string persona_id)
@@ -183,6 +189,7 @@ public abstract class Folks.Persona : Object
* @param persona_store_id the { link PersonaStore.id}
* @param persona_id the Persona identifier (backend-specific)
* @see Persona.build_uid
+ * @since 0.1.13
*/
public static void split_uid (string uid, out string backend_name,
out string persona_store_id, out string persona_id)
diff --git a/folks/presence.vala b/folks/presence.vala
index 9e2230a..6f011da 100644
--- a/folks/presence.vala
+++ b/folks/presence.vala
@@ -107,6 +107,7 @@ public interface Folks.Presence : Object
* number will be returned if the opposite is true.
*
* @return a number representing the similarity of the two types
+ * @since 0.1.11
*/
public static int typecmp (PresenceType type_a, PresenceType type_b)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]