PresenceMixin: move documentation from .h to .c

We tend to put the docstrings in the source files, to avoid rebuilding
the whole library whenever one docstring is edited, and also I guess to
keep the headers smaller maybe?

1 files changed, 0 insertions, 121 deletions

diff --git a/telepathy-glib/presence-mixin.h b/telepathy-glib/presence-mixin.h
index 761b8eb77..caf1acac1 100644
--- a/telepathy-glib/presence-mixin.h
+++ b/telepathy-glib/presence-mixin.h
@@ -32,17 +32,6 @@ typedef struct _TpPresenceStatusOptionalArgumentSpec
     TpPresenceStatusOptionalArgumentSpec;
 typedef struct _TpPresenceStatusSpec TpPresenceStatusSpec;
 
-/**
- * TpPresenceStatusOptionalArgumentSpec
- * @name: Name of the argument as passed over D-Bus
- * @dtype: D-Bus type signature of the argument
- *
- * Structure specifying a supported optional argument for a presence status.
- *
- * In addition to the fields documented here, there are two gpointer fields
- * which must currently be %NULL. A meaning may be defined for these in a
- * future version of telepathy-glib.
- */
 struct _TpPresenceStatusOptionalArgumentSpec {
     const gchar *name;
     const gchar *dtype;
@@ -52,22 +41,6 @@ struct _TpPresenceStatusOptionalArgumentSpec {
     gpointer _future2;
 };
 
-/**
- * TpPresenceStatusSpec
- * @name: String identifier of the presence status
- * @presence_type: A type value, as specified by #TpConnectionPresenceType
- * @self: Indicates if this status may be set on yourself
- * @optional_arguments: An array of #TpPresenceStatusOptionalArgumentSpec
- *  structures representing the optional arguments for this status, terminated
- *  by a NULL name. If there are no optional arguments for a status, this can
- *  be NULL.
- *
- * Structure specifying a supported presence status.
- *
- * In addition to the fields documented here, there are two gpointer fields
- * which must currently be %NULL. A meaning may be defined for these in a
- * future version of telepathy-glib.
- */
 struct _TpPresenceStatusSpec {
     const gchar *name;
     TpConnectionPresenceType presence_type;
@@ -81,20 +54,6 @@ struct _TpPresenceStatusSpec {
 
 typedef struct _TpPresenceStatus TpPresenceStatus;
 
-/**
- * TpPresenceStatus:
- * @index: Index of the presence status in the provided supported presence
- *  statuses array
- * @optional_arguments: A GHashTable mapping of string identifiers to GValues
- *  of the optional status arguments, if any. If there are no optional
- *  arguments, this pointer may be NULL.
- *
- * Structure representing a presence status.
- *
- * In addition to the fields documented here, there are two gpointer fields
- * which must currently be %NULL. A meaning may be defined for these in a
- * future version of telepathy-glib.
- */
 struct _TpPresenceStatus {
     guint index;
     GHashTable *optional_arguments;
@@ -108,68 +67,12 @@ TpPresenceStatus *tp_presence_status_new (guint which,
     GHashTable *optional_arguments) G_GNUC_WARN_UNUSED_RESULT;
 void tp_presence_status_free (TpPresenceStatus *status);
 
-/**
- * TpPresenceMixinStatusAvailableFunc:
- * @obj: An object implementing the presence interface with this mixin
- * @which: The index of the presence status in the provided supported presence
- *  statuses array
- *
- * Signature of the callback used to determine if a given status is currently
- * available to be set on the connection.
- *
- * When implementing the
- * org.freedesktop.Telepathy.Connection.Interface.SimplePresence interface
- * this can be called while DISCONNECTED to determine which statuses can be set
- * in that state.
- *
- * Returns: %TRUE if the status is available, %FALSE if not.
- */
 typedef gboolean (*TpPresenceMixinStatusAvailableFunc) (GObject *obj,
     guint which);
 
-/**
- * TpPresenceMixinGetContactStatusesFunc:
- * @obj: An object with this mixin.
- * @contacts: An array of #TpHandle for the contacts to get presence status for
- * @error: Used to return a Telepathy D-Bus error if %NULL is returned
- *
- * Signature of the callback used to get the stored presence status of
- * contacts. The returned hash table should have contact handles mapped to
- * their respective presence statuses in #TpPresenceStatus structs.
- *
- * The returned hash table will be freed with g_hash_table_destroy. The
- * callback is responsible for ensuring that this does any cleanup that
- * may be necessary.
- *
- * Returns: (transfer full): The contact presence on success, %NULL with
- *  error set on error
- */
 typedef GHashTable *(*TpPresenceMixinGetContactStatusesFunc) (GObject *obj,
     const GArray *contacts, GError **error);
 
-/**
- * TpPresenceMixinSetOwnStatusFunc:
- * @obj: An object with this mixin.
- * @status: The status to set, or NULL for whatever the protocol defines as a
- *  "default" status
- * @error: Used to return a Telepathy D-Bus error if %FALSE is returned
- *
- * Signature of the callback used to commit changes to the user's own presence
- * status in SetStatuses. It is also used in ClearStatus and RemoveStatus to
- * reset the user's own status back to the "default" one with a %NULL status
- * argument.
- *
- * The optional_arguments hash table in @status, if not NULL, will have been
- * filtered so it only contains recognised parameters, so the callback
- * need not (and cannot) check for unrecognised parameters. However, the
- * types of the parameters are not currently checked, so the callback is
- * responsible for doing so.
- *
- * The callback is responsible for emitting PresenceUpdate, if appropriate,
- * by calling tp_presence_mixin_emit_presence_update().
- *
- * Returns: %TRUE if the operation was successful, %FALSE if not.
- */
 typedef gboolean (*TpPresenceMixinSetOwnStatusFunc) (GObject *obj,
     const TpPresenceStatus *status, GError **error);
 
@@ -178,22 +81,6 @@ typedef struct _TpPresenceMixinClassPrivate TpPresenceMixinClassPrivate;
 typedef struct _TpPresenceMixin TpPresenceMixin;
 typedef struct _TpPresenceMixinPrivate TpPresenceMixinPrivate;
 
-/**
- * TpPresenceMixinClass:
- * @status_available: The status-available function that was passed to
- *  tp_presence_mixin_class_init()
- * @get_contact_statuses: The get-contact-statuses function that was passed to
- *  tp_presence_mixin_class_init()
- * @set_own_status: The set-own-status function that was passed to
- *  tp_presence_mixin_class_init()
- * @statuses: The presence statuses array that was passed to
- *  tp_presence_mixin_class_init()
- *
- * Structure to be included in the class structure of objects that
- * use this mixin. Initialize it with tp_presence_mixin_class_init().
- *
- * All fields should be considered read-only.
- */
 struct _TpPresenceMixinClass {
     TpPresenceMixinStatusAvailableFunc status_available;
     TpPresenceMixinGetContactStatusesFunc get_contact_statuses;
@@ -209,14 +96,6 @@ struct _TpPresenceMixinClass {
     gpointer _future4;
 };
 
-/**
- * TpPresenceMixin:
- *
- * Structure to be included in the instance structure of objects that
- * use this mixin. Initialize it with tp_presence_mixin_init().
- *
- * There are no public fields.
- */
 struct _TpPresenceMixin {
   /*<private>*/
   TpPresenceMixinPrivate *priv;