/soc/2013/ankitkv/gobjectification: 96946e21fce5: Fix some more ...
Ankit Vani
a at nevitus.org
Tue Feb 4 17:16:52 EST 2014
Changeset: 96946e21fce5af795c0dae560eb727b590c4359c
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-05 03:45 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/96946e21fce5
Description:
Fix some more gtk-doc warnings till dnssrv
diffstat:
libpurple/certificate.h | 2 +
libpurple/connection.h | 93 +++++++++++++++-------------------
libpurple/conversation.c | 23 ++++----
libpurple/conversation.h | 114 +++++++++++++++++++----------------------
libpurple/conversations.c | 2 +-
libpurple/conversationtypes.c | 65 +++++++++++------------
libpurple/conversationtypes.h | 7 +-
libpurple/core.h | 44 +++++++--------
libpurple/dbus-server.c | 2 +-
libpurple/desktopitem.c | 6 +-
libpurple/dnsquery.c | 12 ++-
libpurple/dnsquery.h | 17 +++--
libpurple/dnssrv.c | 27 +++++----
libpurple/dnssrv.h | 21 ++++---
libpurple/glibcompat.h | 2 +-
15 files changed, 213 insertions(+), 224 deletions(-)
diffs (truncated from 903 to 300 lines):
diff --git a/libpurple/certificate.h b/libpurple/certificate.h
--- a/libpurple/certificate.h
+++ b/libpurple/certificate.h
@@ -74,6 +74,8 @@ typedef enum
PURPLE_CERTIFICATE_INVALID_CHAIN = 0x10000,
PURPLE_CERTIFICATE_REVOKED = 0x20000,
PURPLE_CERTIFICATE_REJECTED = 0x40000,
+
+ /*< private >*/
PURPLE_CERTIFICATE_LAST = 0x80000,
} PurpleCertificateVerificationStatus;
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -41,6 +41,8 @@
typedef struct _PurpleConnection PurpleConnection;
typedef struct _PurpleConnectionClass PurpleConnectionClass;
+typedef struct _PurpleConnectionUiOps PurpleConnectionUiOps;
+
/**
* PurpleConnectionFlags:
* @PURPLE_CONNECTION_FLAG_HTML: Connection sends/receives in 'HTML'
@@ -190,72 +192,58 @@ typedef struct
/**
* PurpleConnectionUiOps:
+ * @connect_progress: When an account is connecting, this operation is called to
+ * notify the UI of what is happening, as well as which @step
+ * out of @step_count has been reached (which might be
+ * displayed as a progress bar).
+ * <sbr/>See purple_connection_update_progress().
+ * @connected: Called when a connection is established (just before the
+ * <link linkend="connections-signed-on"><literal>"signed-on"</literal></link>
+ * signal).
+ * @disconnected: Called when a connection is ended (between the
+ * <link linkend="connections-signing-off"><literal>"signing-off"</literal></link>
+ * and <link linkend="connections-signed-off"><literal>"signed-off"</literal></link>
+ * signals).
+ * @notice: Used to display connection-specific notices. (Pidgin's Gtk user
+ * interface implements this as a no-op; purple_connection_notice(),
+ * which uses this operation, is not used by any of the protocols
+ * shipped with libpurple.)
+ * @network_connected: Called when libpurple discovers that the computer's
+ * network connection is active. On Linux, this uses
+ * Network Manager if available; on Windows, it uses
+ * Win32's network change notification infrastructure.
+ * @network_disconnected: Called when libpurple discovers that the computer's
+ * network connection has gone away.
+ * @report_disconnect: Called when an error causes a connection to be
+ * disconnected. Called before @disconnected.
+ * <sbr/>See purple_connection_error().
+ * <sbr/>@reason: why the connection ended, if known, or
+ * #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not.
+ * <sbr/>@text: a localized message describing the
+ * disconnection in more detail to the user.
*
* Connection UI operations. Used to notify the user of changes to
* connections, such as being disconnected, and to respond to the
* underlying network connection appearing and disappearing. UIs should
* call #purple_connections_set_ui_ops() with an instance of this struct.
*
- * @see @ref ui-ops
+ * See <link linkend="chapter-ui-ops">List of <literal>UiOps</literal> Structures</link>
*/
-typedef struct
+struct _PurpleConnectionUiOps
{
- /**
- * When an account is connecting, this operation is called to notify
- * the UI of what is happening, as well as which @a step out of @a
- * step_count has been reached (which might be displayed as a progress
- * bar).
- * @see #purple_connection_update_progress
- */
void (*connect_progress)(PurpleConnection *gc,
const char *text,
size_t step,
size_t step_count);
- /**
- * Called when a connection is established (just before the
- * @ref signed-on signal).
- */
void (*connected)(PurpleConnection *gc);
-
- /**
- * Called when a connection is ended (between the @ref signing-off
- * and @ref signed-off signals).
- */
void (*disconnected)(PurpleConnection *gc);
- /**
- * Used to display connection-specific notices. (Pidgin's Gtk user
- * interface implements this as a no-op; #purple_connection_notice(),
- * which uses this operation, is not used by any of the protocols
- * shipped with libpurple.)
- */
void (*notice)(PurpleConnection *gc, const char *text);
- /**
- * Called when libpurple discovers that the computer's network
- * connection is active. On Linux, this uses Network Manager if
- * available; on Windows, it uses Win32's network change notification
- * infrastructure.
- */
void (*network_connected)(void);
-
- /**
- * Called when libpurple discovers that the computer's network
- * connection has gone away.
- */
void (*network_disconnected)(void);
- /**
- * Called when an error causes a connection to be disconnected.
- * Called before #disconnected.
- *
- * @reason: why the connection ended, if known, or
- * #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not.
- * @text: a localized message describing the disconnection
- * in more detail to the user.
- * @see #purple_connection_error
- */
void (*report_disconnect)(PurpleConnection *gc,
PurpleConnectionError reason,
const char *text);
@@ -265,7 +253,7 @@ typedef struct
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
-} PurpleConnectionUiOps;
+};
/**
* PurpleConnection:
@@ -302,14 +290,14 @@ G_BEGIN_DECLS
/**
* purple_connection_get_type:
*
- * Returns the GType for the Connection object.
+ * Returns: The #GType for the Connection object.
*/
GType purple_connection_get_type(void);
/**
* purple_connection_error_info_get_type:
*
- * Returns the GType for the PurpleConnectionErrorInfo boxed structure.
+ * Returns: The #GType for the #PurpleConnectionErrorInfo boxed structure.
*/
GType purple_connection_error_info_get_type(void);
@@ -567,13 +555,14 @@ GList *purple_connections_get_connecting
/**
* PURPLE_CONNECTION_IS_VALID:
+ * @gc: The connection to check
*
- * Checks if gc is still a valid pointer to a gc.
+ * Checks if @gc is still a valid pointer to a connection.
*
- * Returns: %TRUE if gc is valid.
+ * This is deprecated -- do not use this. Instead, cancel your asynchronous
+ * request when the #PurpleConnection is destroyed.
*
- * Deprecated: Do not use this. Instead, cancel your asynchronous request
- * when the PurpleConnection is destroyed.
+ * Returns: %TRUE if @gc is valid.
*/
/*
* TODO: Eventually this bad boy will be removed, because it is
diff --git a/libpurple/conversation.c b/libpurple/conversation.c
--- a/libpurple/conversation.c
+++ b/libpurple/conversation.c
@@ -39,31 +39,30 @@
#define PURPLE_CONVERSATION_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_CONVERSATION, PurpleConversationPrivate))
-/** @copydoc _PurpleConversationPrivate */
typedef struct _PurpleConversationPrivate PurpleConversationPrivate;
-/** General private data for a conversation */
+/* General private data for a conversation */
struct _PurpleConversationPrivate
{
- PurpleAccount *account; /**< The user using this conversation. */
+ PurpleAccount *account; /* The user using this conversation. */
- char *name; /**< The name of the conversation. */
- char *title; /**< The window title. */
+ char *name; /* The name of the conversation. */
+ char *title; /* The window title. */
- gboolean logging; /**< The status of logging. */
+ gboolean logging; /* The status of logging. */
- GList *logs; /**< This conversation's logs */
+ GList *logs; /* This conversation's logs */
- PurpleConversationUiOps *ui_ops; /**< UI-specific operations. */
+ PurpleConversationUiOps *ui_ops; /* UI-specific operations. */
- PurpleConnectionFlags features; /**< The supported features */
- GList *message_history; /**< Message history, as a GList of
+ PurpleConnectionFlags features; /* The supported features */
+ GList *message_history; /* Message history, as a GList of
PurpleConversationMessage's */
- PurpleE2eeState *e2ee_state; /**< End-to-end encryption state. */
+ PurpleE2eeState *e2ee_state; /* End-to-end encryption state. */
};
-/**
+/*
* Description of a conversation message
*/
struct _PurpleConversationMessage
diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -165,20 +165,20 @@ struct _PurpleConversation
{
GObject gparent;
+ /*< public >*/
gpointer ui_data;
};
/**
* PurpleConversationClass:
+ * @write_message: Writes a message to a chat or IM conversation. See
+ * purple_conversation_write_message().
*
* Base class for all #PurpleConversation's
*/
struct _PurpleConversationClass {
GObjectClass parent_class;
- /** Writes a message to a chat or IM conversation.
- * @see purple_conversation_write_message()
- */
void (*write_message)(PurpleConversation *conv, const char *who,
const char *message, PurpleMessageFlags flags, time_t mtime);
@@ -199,43 +199,67 @@ struct _PurpleConversationClass {
/**************************************************************************/
/**
* PurpleConversationUiOps:
+ * @create_conversation: Called when @conv is created (but before the
+ * <link linkend="conversations-conversation-created"><literal>"conversation-created"</literal></link>
+ * signal is emitted).
+ * @destroy_conversation: Called just before @conv is freed.
+ * @write_chat: Write a message to a chat. If this field is %NULL, libpurple
+ * will fall back to using @write_conv.
+ * See purple_chat_conversation_write().
+ * @write_im: Write a message to an IM conversation. If this field is %NULL,
+ * libpurple will fall back to using @write_conv.
+ * See purple_im_conversation_write().
+ * @write_conv: Write a message to a conversation. This is used rather than the
+ * chat- or im-specific ops for errors, system messages (such as "x
+ * is now know as y"), and as the fallback if @write_im and
+ * @write_chat are not implemented. It should be implemented, or
+ * the UI will miss conversation error messages and your users will
+ * hate you. See purple_conversation_write().
+ * @chat_add_users: Add @cbuddies to a chat.
+ * <sbr/>@cbuddies: A GList of #PurpleChatUser structs.
+ * <sbr/>@new_arrivals: Whether join notices should be shown.
+ * (Join notices are actually written to
+ * the conversation by
+ * purple_chat_conversation_add_users())
+ * @chat_rename_user: Rename the user in this chat named @old_name to @new_name.
+ * (The rename message is written to the conversation by
+ * libpurple.) See purple_chat_conversation_rename_user().
+ * <sbr/>@new_alias: @new_name's new alias, if they have one.
+ * @chat_remove_users: Remove @users from a chat @chat.
+ * See purple_chat_conversation_remove_users().
+ * @chat_update_user: Called when a user's flags are changed.
+ * See purple_chat_user_set_flags().
+ * @present: Present this conversation to the user; for example, by displaying
+ * the IM dialog.
+ * @has_focus: If this UI has a concept of focus (as in a windowing system) and
+ * this conversation has the focus, return %TRUE; otherwise, return
+ * %FALSE.
+ * @custom_smiley_add: Add a custom smiley
+ * @custom_smiley_write: Write a custom smiley
+ * @custom_smiley_close: Close a custom smiley
+ * @send_confirm: Prompt the user for confirmation to send @message. This
+ * function should arrange for the message to be sent if the user
+ * accepts. If this field is %NULL, libpurple will fall back to
+ * using purple_request_action().
*
* Conversation operations and events.
*
* Any UI representing a conversation must assign a filled-out
- * PurpleConversationUiOps structure to the PurpleConversation.
+ * #PurpleConversationUiOps structure to the #PurpleConversation.
*/
struct _PurpleConversationUiOps
More information about the Commits
mailing list