/soc/2013/ankitkv/gobjectification: baddcf712dd3: Convert docs f...
Ankit Vani
a at nevitus.org
Fri Jan 31 16:02:54 EST 2014
Changeset: baddcf712dd35236ed832910afeb544dbc115549
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-01 02:31 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/baddcf712dd3
Description:
Convert docs from doxygen to gtk-doc format for status.h and xfer.h
diffstat:
libpurple/status.h | 257 ++++++++++++++++++-----------
libpurple/xfer.h | 454 ++++++++++++++++++++++++++++++++--------------------
2 files changed, 439 insertions(+), 272 deletions(-)
diffs (truncated from 1738 to 300 lines):
diff --git a/libpurple/status.h b/libpurple/status.h
--- a/libpurple/status.h
+++ b/libpurple/status.h
@@ -33,21 +33,21 @@
#define PURPLE_IS_STATUS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_STATUS))
#define PURPLE_STATUS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_STATUS, PurpleStatusClass))
-/** @copydoc _PurpleStatus */
typedef struct _PurpleStatus PurpleStatus;
-/** @copydoc _PurpleStatusClass */
typedef struct _PurpleStatusClass PurpleStatusClass;
#define PURPLE_TYPE_STATUS_TYPE (purple_status_type_get_type())
/**
- * PurpleStatusType's are created by each PRPL. They outline the
+ * PurpleStatusType:
+ *
+ * PurpleStatusType's are created by each protocol. They outline the
* available statuses of the protocol. AIM, for example, supports
* an available state with an optional available message, an away
* state with a mandatory message, and an invisible state (which is
* technically "independent" of the other two, but we'll get into
* that later). PurpleStatusTypes are very permanent. They are
- * hardcoded in each PRPL and will not change often. And because
+ * hardcoded in each protocol and will not change often. And because
* they are hardcoded, they do not need to be saved to any XML file.
*/
typedef struct _PurpleStatusType PurpleStatusType;
@@ -65,6 +65,8 @@ typedef struct _PurpleMood {
} PurpleMood;
/**
+ * PurpleStatusPrimitive:
+ *
* A primitive defining the basic structure of a status type.
*/
/*
@@ -103,6 +105,8 @@ typedef enum
#define PURPLE_MOOD_COMMENT "moodtext"
/**
+ * PurpleStatus:
+ *
* A PurpleStatus can be thought of as an "instance" of a PurpleStatusType.
* If you're familiar with object-oriented programming languages
* then this should be immediately clear. Say, for example, that
@@ -110,7 +114,7 @@ typedef enum
* PurpleBuddy node for this person in your buddy list. Purple wants
* to mark this buddy as "away," so it creates a new PurpleStatus.
* The PurpleStatus has its PurpleStatusType set to the "away" state
- * for the oscar PRPL. The PurpleStatus also contains the buddy's
+ * for the oscar protocol. The PurpleStatus also contains the buddy's
* away message. PurpleStatuses are sometimes saved, depending on
* the context. The current PurpleStatuses associated with each of
* your accounts are saved so that the next time you start Purple,
@@ -136,7 +140,11 @@ struct _PurpleStatus
GObject gparent;
};
-/** Base class for all #PurpleStatus's */
+/**
+ * PurpleStatusClass:
+ *
+ * Base class for all #PurpleStatus's
+ */
struct _PurpleStatusClass {
GObjectClass parent_class;
@@ -155,32 +163,35 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_primitive_get_id_from_type:
+ * @type: A primitive status type.
+ *
* Lookup the id of a primitive status type based on the type. This
* ID is a unique plain-text name of the status, without spaces.
*
- * @type: A primitive status type.
- *
* Returns: The unique ID for this type.
*/
const char *purple_primitive_get_id_from_type(PurpleStatusPrimitive type);
/**
+ * purple_primitive_get_name_from_type:
+ * @type: A primitive status type.
+ *
* Lookup the name of a primitive status type based on the type. This
* name is the plain-English name of the status type. It is usually one
* or two words.
*
- * @type: A primitive status type.
- *
* Returns: The name of this type, suitable for users to see.
*/
const char *purple_primitive_get_name_from_type(PurpleStatusPrimitive type);
/**
+ * purple_primitive_get_type_from_id:
+ * @id: The unique ID of a primitive status type.
+ *
* Lookup the value of a primitive status type based on the id. The
* ID is a unique plain-text name of the status, without spaces.
*
- * @id: The unique ID of a primitive status type.
- *
* Returns: The PurpleStatusPrimitive value.
*/
PurpleStatusPrimitive purple_primitive_get_type_from_id(const char *id);
@@ -193,13 +204,14 @@ PurpleStatusPrimitive purple_primitive_g
/*@{*/
/**
+ * purple_status_type_get_type:
+ *
* Returns the GType for the PurpleStatusType boxed structure.
*/
GType purple_status_type_get_type(void);
/**
- * Creates a new status type.
- *
+ * purple_status_type_new_full:
* @primitive: The primitive status type.
* @id: The ID of the status type, or %NULL to use the id of
* the primitive status type.
@@ -211,6 +223,8 @@ GType purple_status_type_get_type(void);
* @independent: TRUE if this is an independent (non-exclusive)
* status type.
*
+ * Creates a new status type.
+ *
* Returns: A new status type.
*/
PurpleStatusType *purple_status_type_new_full(PurpleStatusPrimitive primitive,
@@ -220,9 +234,7 @@ PurpleStatusType *purple_status_type_new
gboolean independent);
/**
- * Creates a new status type with some default values (
- * saveable and not independent).
- *
+ * purple_status_type_new:
* @primitive: The primitive status type.
* @id: The ID of the status type, or %NULL to use the id of
* the primitive status type.
@@ -230,6 +242,9 @@ PurpleStatusType *purple_status_type_new
* name of the primitive status type.
* @user_settable: TRUE if this is a status the user can manually set.
*
+ * Creates a new status type with some default values (
+ * saveable and not independent).
+ *
* Returns: A new status type.
*/
PurpleStatusType *purple_status_type_new(PurpleStatusPrimitive primitive,
@@ -237,8 +252,7 @@ PurpleStatusType *purple_status_type_new
gboolean user_settable);
/**
- * Creates a new status type with attributes.
- *
+ * purple_status_type_new_with_attrs:
* @primitive: The primitive status type.
* @id: The ID of the status type, or %NULL to use the id of
* the primitive status type.
@@ -254,6 +268,8 @@ PurpleStatusType *purple_status_type_new
* @attr_value: The value type of the first attribute.
* @...: Additional attribute information.
*
+ * Creates a new status type with attributes.
+ *
* Returns: A new status type.
*/
PurpleStatusType *purple_status_type_new_with_attrs(PurpleStatusPrimitive primitive,
@@ -267,119 +283,131 @@ PurpleStatusType *purple_status_type_new
GValue *attr_value, ...) G_GNUC_NULL_TERMINATED;
/**
+ * purple_status_type_destroy:
+ * @status_type: The status type to destroy.
+ *
* Destroys a status type.
- *
- * @status_type: The status type to destroy.
*/
void purple_status_type_destroy(PurpleStatusType *status_type);
/**
+ * purple_status_type_get_primitive:
+ * @status_type: The status type.
+ *
* Returns the primitive type of a status type.
*
- * @status_type: The status type.
- *
* Returns: The primitive type of the status type.
*/
PurpleStatusPrimitive purple_status_type_get_primitive(
const PurpleStatusType *status_type);
/**
+ * purple_status_type_get_id:
+ * @status_type: The status type.
+ *
* Returns the ID of a status type.
*
- * @status_type: The status type.
- *
* Returns: The ID of the status type.
*/
const char *purple_status_type_get_id(const PurpleStatusType *status_type);
/**
+ * purple_status_type_get_name:
+ * @status_type: The status type.
+ *
* Returns the name of a status type.
*
- * @status_type: The status type.
- *
* Returns: The name of the status type.
*/
const char *purple_status_type_get_name(const PurpleStatusType *status_type);
/**
+ * purple_status_type_is_saveable:
+ * @status_type: The status type.
+ *
* Returns whether or not the status type is saveable.
*
- * @status_type: The status type.
- *
* Returns: TRUE if user-defined statuses based off this type are saveable.
* FALSE otherwise.
*/
gboolean purple_status_type_is_saveable(const PurpleStatusType *status_type);
/**
+ * purple_status_type_is_user_settable:
+ * @status_type: The status type.
+ *
* Returns whether or not the status type can be set or modified by the
* user.
*
- * @status_type: The status type.
- *
* Returns: TRUE if the status type can be set or modified by the user.
* FALSE if it's a protocol-set setting.
*/
gboolean purple_status_type_is_user_settable(const PurpleStatusType *status_type);
/**
+ * purple_status_type_is_independent:
+ * @status_type: The status type.
+ *
* Returns whether or not the status type is independent.
*
* Independent status types are non-exclusive. If other status types on
* the same hierarchy level are set, this one will not be affected.
*
- * @status_type: The status type.
- *
* Returns: TRUE if the status type is independent, or FALSE otherwise.
*/
gboolean purple_status_type_is_independent(const PurpleStatusType *status_type);
/**
+ * purple_status_type_is_exclusive:
+ * @status_type: The status type.
+ *
* Returns whether the status type is exclusive.
*
- * @status_type: The status type.
- *
* Returns: TRUE if the status type is exclusive, FALSE otherwise.
*/
gboolean purple_status_type_is_exclusive(const PurpleStatusType *status_type);
/**
+ * purple_status_type_is_available:
+ * @status_type: The status type.
+ *
* Returns whether or not a status type is available.
*
* Available status types are online and possibly invisible, but not away.
*
- * @status_type: The status type.
- *
* Returns: TRUE if the status is available, or FALSE otherwise.
*/
gboolean purple_status_type_is_available(const PurpleStatusType *status_type);
/**
- * Returns the attribute with the specified ID.
- *
+ * purple_status_type_get_attr:
* @status_type: The status type containing the attribute.
More information about the Commits
mailing list