[folks] Fix documentation of enum members
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [folks] Fix documentation of enum members
- Date: Sun, 12 Dec 2010 17:20:37 +0000 (UTC)
commit 037dab458f415314fe33dc5fd9082cbac4e198ec
Author: Philip Withnall <philip withnall collabora co uk>
Date: Sun Dec 12 16:29:07 2010 +0000
Fix documentation of enum members
The documentation comments for enum members have to be proper valadoc comments
(i.e. starting with /** and ending with */ on separate lines).
folks/groupable.vala | 60 +++++++++++++++++++++++++++++++++++---------------
folks/types.vala | 12 +++++++--
2 files changed, 51 insertions(+), 21 deletions(-)
---
diff --git a/folks/groupable.vala b/folks/groupable.vala
index ed0add5..ae1e115 100644
--- a/folks/groupable.vala
+++ b/folks/groupable.vala
@@ -35,41 +35,64 @@ public interface Folks.Groupable : Object
*/
public static enum ChangeReason
{
- /* No reason was provided for this change.
+ /**
+ * No reason was provided for this change.
*
- * This is used when a member joins or leaves a group normally. */
+ * This is used when a member joins or leaves a group normally.
+ */
NONE = 0,
- /* The change is due to a member going offline.
+ /**
+ * The change is due to a member going offline.
*
* Also used when member is already offline, but this wasn't known
- * previously. */
+ * previously.
+ */
OFFLINE = 1,
- /* The change is due to a kick operation. */
+ /**
+ * The change is due to a kick operation.
+ */
KICKED = 2,
- /* The change is due to a busy indication. */
+ /**
+ * The change is due to a busy indication.
+ */
BUSY = 3,
- /* The change is due to an invitation. */
+ /**
+ * The change is due to an invitation.
+ */
INVITED = 4,
- /* The change is due to a kick+ban operation. */
+ /**
+ * The change is due to a kick+ban operation.
+ */
BANNED = 5,
- /* The change is due to an error occurring. */
+ /**
+ * The change is due to an error occurring.
+ */
ERROR = 6,
- /* The change is because the requested member does not exist.
+ /**
+ * The change is because the requested member does not exist.
*
* For instance, if the user invites a nonexistent contact to a chatroom
- * or attempts to call a nonexistent contact */
+ * or attempts to call a nonexistent contact
+ */
INVALID_MEMBER = 7,
- /* The change is because the requested contact did not respond. */
+ /**
+ * The change is because the requested contact did not respond.
+ */
NO_ANSWER = 8,
- /* The change is because a member's unique identifier changed.
+ /**
+ * The change is because a member's unique identifier changed.
*
* There must be exactly one member in the removed set and exactly one
- * member in one of the added sets. */
+ * member in one of the added sets.
+ */
RENAMED = 9,
- /* The change is because there was no permission to contact the requested
- * member. */
+ /**
+ * The change is because there was no permission to contact the requested
+ * member.
+ */
PERMISSION_DENIED = 10,
- /* If members are removed with this reason code, the change is because the
+ /**
+ * If members are removed with this reason code, the change is because the
* group has split into unconnected parts which can only communicate
* within themselves (e.g. netsplits on IRC use this reason code).
*
@@ -84,7 +107,8 @@ public interface Folks.Groupable : Object
* group all along, and the contacts we indicate to be in the group
* (including the local user) have just rejoined the group with reason
* Separated. Application protocols in Tubes should be prepared to cope
- * with this situation. */
+ * with this situation.
+ */
SEPARATED = 11
}
diff --git a/folks/types.vala b/folks/types.vala
index ba93480..fb897cb 100644
--- a/folks/types.vala
+++ b/folks/types.vala
@@ -27,11 +27,17 @@ namespace Folks
*/
public static enum MaybeBool
{
- /* This value is explicitly unset. */
+ /**
+ * This value is explicitly unset.
+ */
UNSET = 0,
- /* False (this value was set from its default of UNSET). */
+ /**
+ * False (this value was set from its default of UNSET).
+ */
FALSE = 1,
- /* True (this value was set from its default of UNSET). */
+ /**
+ * True (this value was set from its default of UNSET).
+ */
TRUE = 2,
}
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]