[folks] Remove { inheritDoc} from folks-telepathy documentation
- From: Travis Reitter <treitter src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [folks] Remove { inheritDoc} from folks-telepathy documentation
- Date: Tue, 21 Sep 2010 00:00:05 +0000 (UTC)
commit a9ceea30f13bb6a223d9a71985e9e4ae6ce69069
Author: Philip Withnall <philip withnall collabora co uk>
Date: Wed Sep 15 11:45:25 2010 +0100
Remove { inheritDoc} from folks-telepathy documentation
It's not possible to inherit documentation across packages, so we have to
rely on links instead. Helps: bgo#629526
backends/telepathy/lib/tpf-persona-store.vala | 29 +++++++++++++++++-----
backends/telepathy/lib/tpf-persona.vala | 32 ++++++++++++++++++------
2 files changed, 46 insertions(+), 15 deletions(-)
---
diff --git a/backends/telepathy/lib/tpf-persona-store.vala b/backends/telepathy/lib/tpf-persona-store.vala
index 064ed6e..c8cb1c9 100644
--- a/backends/telepathy/lib/tpf-persona-store.vala
+++ b/backends/telepathy/lib/tpf-persona-store.vala
@@ -69,22 +69,31 @@ public class Tpf.PersonaStore : Folks.PersonaStore
public Account account { get; construct; }
/**
- * { inheritDoc}
+ * The type of persona store this is.
+ *
+ * See { link Folks.PersonaStore.type_id}.
*/
public override string type_id { get; private set; }
/**
- * { inheritDoc}
+ * The human-readable, service-specific name used to represent the
+ * PersonaStore to the user.
+ *
+ * See { link Folks.PersonaStore.display_name}.
*/
public override string display_name { get; private set; }
/**
- * { inheritDoc}
+ * The instance identifier for this PersonaStore.
+ *
+ * See { link Folks.PersonaStore.id}.
*/
public override string id { get; private set; }
/**
- * { inheritDoc}
+ * The { link Persona}s exposed by this PersonaStore.
+ *
+ * See { link Folks.PersonaStore.personas}.
*/
public override HashTable<string, Persona> personas
{
@@ -139,7 +148,9 @@ public class Tpf.PersonaStore : Folks.PersonaStore
}
/**
- * { inheritDoc}
+ * Prepare the PersonaStore for use.
+ *
+ * See { link Folks.PersonaStore.prepare}.
*/
public override async void prepare ()
{
@@ -663,7 +674,9 @@ public class Tpf.PersonaStore : Folks.PersonaStore
}
/**
- * { inheritDoc}
+ * Remove a { link Persona} from the PersonaStore.
+ *
+ * See { link Folks.PersonaStore.remove_persona}.
*/
public override async void remove_persona (Folks.Persona persona)
{
@@ -1081,7 +1094,9 @@ public class Tpf.PersonaStore : Folks.PersonaStore
}
/**
- * { inheritDoc}
+ * Add a new { link Persona} to the PersonaStore.
+ *
+ * See { link Folks.PersonaStore.add_persona_from_details}.
*/
public override async Folks.Persona? add_persona_from_details (
HashTable<string, Value?> details) throws Folks.PersonaStoreError
diff --git a/backends/telepathy/lib/tpf-persona.vala b/backends/telepathy/lib/tpf-persona.vala
index 58d60a6..d830c5c 100644
--- a/backends/telepathy/lib/tpf-persona.vala
+++ b/backends/telepathy/lib/tpf-persona.vala
@@ -52,22 +52,30 @@ public class Tpf.Persona : Folks.Persona,
private bool is_constructed = false;
/**
- * { inheritDoc}
+ * An avatar for the Persona.
+ *
+ * See { link Folks.Avatar.avatar}.
*/
public File avatar { get; set; }
/**
- * { inheritDoc}
+ * The Persona's presence type.
+ *
+ * See { link Folks.Presence.presence_type}.
*/
public Folks.PresenceType presence_type { get; private set; }
/**
- * { inheritDoc}
+ * The Persona's presence message.
+ *
+ * See { link Folks.Presence.presence_message}.
*/
public string presence_message { get; private set; }
/**
- * { inheritDoc}
+ * An alias for the Persona.
+ *
+ * See { link Folks.Aliasable.alias}.
*/
public string alias
{
@@ -85,7 +93,9 @@ public class Tpf.Persona : Folks.Persona,
}
/**
- * { inheritDoc}
+ * Whether this Persona is a user-defined favourite.
+ *
+ * See { link Folks.Favourite.is_favourite}.
*/
public bool is_favourite
{
@@ -103,7 +113,9 @@ public class Tpf.Persona : Folks.Persona,
}
/**
- * { inheritDoc}
+ * A mapping of IM protocol to an ordered set of IM addresses.
+ *
+ * See { link Folks.IMable.im_addresses}.
*/
public HashTable<string, GenericArray<string>> im_addresses
{
@@ -112,7 +124,9 @@ public class Tpf.Persona : Folks.Persona,
}
/**
- * { inheritDoc}
+ * A mapping of group ID to whether the contact is a member.
+ *
+ * See { link Folks.Groupable.groups}.
*/
public HashTable<string, bool> groups
{
@@ -142,7 +156,9 @@ public class Tpf.Persona : Folks.Persona,
}
/**
- * { inheritDoc}
+ * Add or remove the Persona from the specified group.
+ *
+ * See { link Folks.Groupable.change_group}.
*/
public async void change_group (string group, bool is_member)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]