[folks] Break up some long class summaries to simplify the doc index.



commit 8a1346a8420bdbe01bd460e5e5dbd99b9d336604
Author: Travis Reitter <travis reitter collabora co uk>
Date:   Tue Oct 19 11:31:31 2010 -0700

    Break up some long class summaries to simplify the doc index.

 folks/individual-aggregator.vala |    6 ++++--
 folks/persona.vala               |    6 ++++--
 folks/presence.vala              |   10 ++++++----
 3 files changed, 14 insertions(+), 8 deletions(-)
---
diff --git a/folks/individual-aggregator.vala b/folks/individual-aggregator.vala
index e7b9902..23096b6 100644
--- a/folks/individual-aggregator.vala
+++ b/folks/individual-aggregator.vala
@@ -53,9 +53,11 @@ public errordomain Folks.IndividualAggregatorError
 }
 
 /**
- * Allows access to the { link Individual}s which have been created through
+ * Stores { link Individual}s which have been created through
  * aggregation of all the { link Persona}s provided by the various
- * { link Backend}s. This is the main interface for client applications.
+ * { link Backend}s.
+ *
+ * This is the main interface for client applications.
  */
 public class Folks.IndividualAggregator : Object
 {
diff --git a/folks/persona.vala b/folks/persona.vala
index 281f257..7733aa1 100644
--- a/folks/persona.vala
+++ b/folks/persona.vala
@@ -23,8 +23,10 @@ using GLib;
 /**
  * Represents a "shard" of a person from a single source (a single
  * { link Backend}), such as an XMPP contact from Telepathy or a vCard contact
- * from evolution-data-server. All the personas belonging to one physical person
- * are aggregated to form a single { link Individual} representing that person.
+ * from evolution-data-server.
+ *
+ * All the personas belonging to one physical person are aggregated to form a
+ * single { link Individual} representing that person.
  */
 public abstract class Folks.Persona : Object
 {
diff --git a/folks/presence.vala b/folks/presence.vala
index 1582257..83ce6b6 100644
--- a/folks/presence.vala
+++ b/folks/presence.vala
@@ -42,10 +42,12 @@ public enum Folks.PresenceType {
 
 /**
  * Interface exposing a { link Persona}'s or { link Individual}'s presence;
- * their current availability, such as for chatting. If the { link Backend}
- * providing the { link Persona} doesn't support presence, the { link Persona}'s
- * `presence_type` will be set to { link PresenceType.UNSET} and their
- * `presence_message` will be an empty string.
+ * their current availability, such as for chatting.
+ *
+ * If the { link Backend} providing the { link Persona} doesn't support
+ * presence, the { link Persona}'s `presence_type` will be set to
+ * { link PresenceType.UNSET} and their `presence_message` will be an empty
+ * string.
  */
 public interface Folks.Presence : Object
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]