/soc/2013/ankitkv/gobjectification: c444f4b65fb7: Convert doxyge...
Ankit Vani
a at nevitus.org
Wed Jan 29 18:19:47 EST 2014
Changeset: c444f4b65fb7bc59f66e9ddb8d53a1f321073c85
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-30 04:49 +0530
Branch: soc.2013.gobjectification.gtkdoc
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/c444f4b65fb7
Description:
Convert doxygen comments to gtk-doc format for connection, conversations, dbus-server, version
diffstat:
libpurple/connection.h | 296 +++++++++++++++++++-----------
libpurple/conversation.h | 407 +++++++++++++++++++++++++----------------
libpurple/conversations.h | 49 +++-
libpurple/conversationtypes.h | 364 +++++++++++++++++++++++--------------
libpurple/dbus-server.h | 136 +++++++------
libpurple/version.h.in | 36 ++-
6 files changed, 798 insertions(+), 490 deletions(-)
diffs (truncated from 2721 to 300 lines):
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -36,106 +36,129 @@
#define PURPLE_TYPE_CONNECTION_ERROR_INFO (purple_connection_error_info_get_type())
-/** @copydoc _PurpleConnection */
typedef struct _PurpleConnection PurpleConnection;
-/** @copydoc _PurpleConnectionClass */
typedef struct _PurpleConnectionClass PurpleConnectionClass;
/**
+ * PurpleConnectionFlags:
+ * @PURPLE_CONNECTION_FLAG_HTML: Connection sends/receives in 'HTML'
+ * @PURPLE_CONNECTION_FLAG_NO_BGCOLOR: Connection does not send/receive
+ * background colors
+ * @PURPLE_CONNECTION_FLAG_AUTO_RESP: Send auto responses when away
+ * @PURPLE_CONNECTION_FLAG_FORMATTING_WBFO: The text buffer must be formatted
+ * as a whole
+ * @PURPLE_CONNECTION_FLAG_NO_NEWLINES: No new lines are allowed in outgoing
+ * messages
+ * @PURPLE_CONNECTION_FLAG_NO_FONTSIZE: Connection does not send/receive font
+ * sizes
+ * @PURPLE_CONNECTION_FLAG_NO_URLDESC: Connection does not support descriptions
+ * with links
+ * @PURPLE_CONNECTION_FLAG_NO_IMAGES: Connection does not support sending of
+ * images
+ * @PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY: Connection supports sending
+ * and receiving custom smileys
+ * @PURPLE_CONNECTION_FLAG_SUPPORT_MOODS: Connection supports setting moods
+ * @PURPLE_CONNECTION_FLAG_SUPPORT_MOOD_MESSAGES: Connection supports setting
+ * a message on moods
+ *
* Flags to change behavior of the client for a given connection.
*/
typedef enum /*< flags >*/
{
- PURPLE_CONNECTION_FLAG_HTML = 0x0001, /**< Connection sends/receives in 'HTML' */
- PURPLE_CONNECTION_FLAG_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive background colors */
- PURPLE_CONNECTION_FLAG_AUTO_RESP = 0x0004, /**< Send auto responses when away */
- PURPLE_CONNECTION_FLAG_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */
- PURPLE_CONNECTION_FLAG_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */
- PURPLE_CONNECTION_FLAG_NO_FONTSIZE = 0x0020, /**< Connection does not send/receive font sizes */
- PURPLE_CONNECTION_FLAG_NO_URLDESC = 0x0040, /**< Connection does not support descriptions with links */
- PURPLE_CONNECTION_FLAG_NO_IMAGES = 0x0080, /**< Connection does not support sending of images */
- PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY = 0x0100, /**< Connection supports sending and receiving custom smileys */
- PURPLE_CONNECTION_FLAG_SUPPORT_MOODS = 0x0200, /**< Connection supports setting moods */
- PURPLE_CONNECTION_FLAG_SUPPORT_MOOD_MESSAGES = 0x0400 /**< Connection supports setting a message on moods */
+ PURPLE_CONNECTION_FLAG_HTML = 0x0001,
+ PURPLE_CONNECTION_FLAG_NO_BGCOLOR = 0x0002,
+ PURPLE_CONNECTION_FLAG_AUTO_RESP = 0x0004,
+ PURPLE_CONNECTION_FLAG_FORMATTING_WBFO = 0x0008,
+ PURPLE_CONNECTION_FLAG_NO_NEWLINES = 0x0010,
+ PURPLE_CONNECTION_FLAG_NO_FONTSIZE = 0x0020,
+ PURPLE_CONNECTION_FLAG_NO_URLDESC = 0x0040,
+ PURPLE_CONNECTION_FLAG_NO_IMAGES = 0x0080,
+ PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY = 0x0100,
+ PURPLE_CONNECTION_FLAG_SUPPORT_MOODS = 0x0200,
+ PURPLE_CONNECTION_FLAG_SUPPORT_MOOD_MESSAGES = 0x0400
} PurpleConnectionFlags;
+/**
+ * PurpleConnectionState:
+ * @PURPLE_CONNECTION_DISCONNECTED: Disconnected.
+ * @PURPLE_CONNECTION_CONNECTED: Connected.
+ * @PURPLE_CONNECTION_CONNECTING: Connecting.
+ */
typedef enum
{
- PURPLE_CONNECTION_DISCONNECTED = 0, /**< Disconnected. */
- PURPLE_CONNECTION_CONNECTED, /**< Connected. */
- PURPLE_CONNECTION_CONNECTING /**< Connecting. */
-
+ PURPLE_CONNECTION_DISCONNECTED = 0,
+ PURPLE_CONNECTION_CONNECTED,
+ PURPLE_CONNECTION_CONNECTING
} PurpleConnectionState;
/**
+ * PurpleConnectionError:
+ * @PURPLE_CONNECTION_ERROR_NETWORK_ERROR: There was an error sending or
+ * receiving on the network socket, or there was some protocol error
+ * (such as the server sending malformed data).
+ * @PURPLE_CONNECTION_ERROR_INVALID_USERNAME: The username supplied was not
+ * valid.
+ * @PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED: The username, password or
+ * some other credential was incorrect. Use
+ * #PURPLE_CONNECTION_ERROR_INVALID_USERNAME instead if the username
+ * is known to be invalid.
+ * @PURPLE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE: libpurple doesn't speak
+ * any of the authentication methods the server offered.
+ * @PURPLE_CONNECTION_ERROR_NO_SSL_SUPPORT: libpurple was built without SSL
+ * support, and the connection needs SSL.
+ * @PURPLE_CONNECTION_ERROR_ENCRYPTION_ERROR: There was an error negotiating
+ * SSL on this connection, or the server does not support encryption
+ * but an account option was set to require it.
+ * @PURPLE_CONNECTION_ERROR_NAME_IN_USE: Someone is already connected to the
+ * server using the name you are trying to connect with.
+ * @PURPLE_CONNECTION_ERROR_INVALID_SETTINGS: The username/server/other
+ * preference for the account isn't valid. For instance, on IRC the
+ * username cannot contain white space. This reason should not be used
+ * for incorrect passwords etc: use
+ * #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED for that.
+ * @todo This reason really shouldn't be necessary. Usernames and
+ * other account preferences should be validated when the
+ * account is created.
+ * @PURPLE_CONNECTION_ERROR_CERT_NOT_PROVIDED: The server did not provide a
+ * SSL certificate.
+ * @PURPLE_CONNECTION_ERROR_CERT_UNTRUSTED: The server's SSL certificate could
+ * not be trusted.
+ * @PURPLE_CONNECTION_ERROR_CERT_EXPIRED: The server's SSL certificate has
+ * expired.
+ * @PURPLE_CONNECTION_ERROR_CERT_NOT_ACTIVATED: The server's SSL certificate is
+ * not yet valid.
+ * @PURPLE_CONNECTION_ERROR_CERT_HOSTNAME_MISMATCH: The server's SSL
+ * certificate did not match its hostname.
+ * @PURPLE_CONNECTION_ERROR_CERT_FINGERPRINT_MISMATCH: The server's SSL
+ * certificate does not have the expected fingerprint.
+ * @PURPLE_CONNECTION_ERROR_CERT_SELF_SIGNED: The server's SSL certificate is
+ * self-signed.
+ * @PURPLE_CONNECTION_ERROR_CERT_OTHER_ERROR: There was some other error
+ * validating the server's SSL certificate.
+ * @PURPLE_CONNECTION_ERROR_OTHER_ERROR: Some other error occurred which fits
+ * into none of the other categories.
+ *
* Possible errors that can cause a connection to be closed.
*/
typedef enum
{
- /** There was an error sending or receiving on the network socket, or
- * there was some protocol error (such as the server sending malformed
- * data).
- */
PURPLE_CONNECTION_ERROR_NETWORK_ERROR = 0,
- /** The username supplied was not valid. */
PURPLE_CONNECTION_ERROR_INVALID_USERNAME = 1,
- /** The username, password or some other credential was incorrect. Use
- * #PURPLE_CONNECTION_ERROR_INVALID_USERNAME instead if the username
- * is known to be invalid.
- */
PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED = 2,
- /** libpurple doesn't speak any of the authentication methods the
- * server offered.
- */
PURPLE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE = 3,
- /** libpurple was built without SSL support, and the connection needs
- * SSL.
- */
PURPLE_CONNECTION_ERROR_NO_SSL_SUPPORT = 4,
- /** There was an error negotiating SSL on this connection, or the
- * server does not support encryption but an account option was set to
- * require it.
- */
PURPLE_CONNECTION_ERROR_ENCRYPTION_ERROR = 5,
- /** Someone is already connected to the server using the name you are
- * trying to connect with.
- */
PURPLE_CONNECTION_ERROR_NAME_IN_USE = 6,
-
- /** The username/server/other preference for the account isn't valid.
- * For instance, on IRC the username cannot contain white space.
- * This reason should not be used for incorrect passwords etc: use
- * #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED for that.
- *
- * @todo This reason really shouldn't be necessary. Usernames and
- * other account preferences should be validated when the
- * account is created.
- */
PURPLE_CONNECTION_ERROR_INVALID_SETTINGS = 7,
-
- /** The server did not provide a SSL certificate. */
PURPLE_CONNECTION_ERROR_CERT_NOT_PROVIDED = 8,
- /** The server's SSL certificate could not be trusted. */
PURPLE_CONNECTION_ERROR_CERT_UNTRUSTED = 9,
- /** The server's SSL certificate has expired. */
PURPLE_CONNECTION_ERROR_CERT_EXPIRED = 10,
- /** The server's SSL certificate is not yet valid. */
PURPLE_CONNECTION_ERROR_CERT_NOT_ACTIVATED = 11,
- /** The server's SSL certificate did not match its hostname. */
PURPLE_CONNECTION_ERROR_CERT_HOSTNAME_MISMATCH = 12,
- /** The server's SSL certificate does not have the expected
- * fingerprint.
- */
PURPLE_CONNECTION_ERROR_CERT_FINGERPRINT_MISMATCH = 13,
- /** The server's SSL certificate is self-signed. */
PURPLE_CONNECTION_ERROR_CERT_SELF_SIGNED = 14,
- /** There was some other error validating the server's SSL certificate.
- */
PURPLE_CONNECTION_ERROR_CERT_OTHER_ERROR = 15,
- /** Some other error occurred which fits into none of the other
- * categories.
- */
/* purple_connection_error() in connection.c uses the fact that
* this is the last member of the enum when sanity-checking; if other
* reasons are added after it, the check must be updated.
@@ -143,12 +166,16 @@ typedef enum
PURPLE_CONNECTION_ERROR_OTHER_ERROR = 16
} PurpleConnectionError;
-/** Holds the type of an error along with its description. */
+/**
+ * PurpleConnectionErrorInfo:
+ * @type: The type of error.
+ * @description: A localised, human-readable description of the error.
+ *
+ * Holds the type of an error along with its description.
+ */
typedef struct
{
- /** The type of error. */
PurpleConnectionError type;
- /** A localised, human-readable description of the error. */
char *description;
} PurpleConnectionErrorInfo;
@@ -160,6 +187,8 @@ typedef struct
#include "sslconn.h"
/**
+ * PurpleConnectionUiOps:
+ *
* 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
@@ -237,6 +266,8 @@ typedef struct
} PurpleConnectionUiOps;
/**
+ * PurpleConnection:
+ *
* Represents an active connection on an account.
*/
struct _PurpleConnection
@@ -244,7 +275,11 @@ struct _PurpleConnection
GObject gparent;
};
-/** Base class for all #PurpleConnection's */
+/**
+ * PurpleConnectionClass:
+ *
+ * Base class for all #PurpleConnection's
+ */
struct _PurpleConnectionClass {
GObjectClass parent_class;
@@ -263,70 +298,82 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_connection_get_type:
+ *
* 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.
*/
GType purple_connection_error_info_get_type(void);
/**
+ * purple_connection_set_state:
+ * @gc: The connection.
+ * @state: The connection state.
+ *
* Sets the connection state. Protocols should call this and pass in
* the state #PURPLE_CONNECTION_CONNECTED when the account is completely
* signed on. What does it mean to be completely signed on? If
* the core can call protocol's set_status, and it successfully changes
* your status, then the account is online.
- *
- * @gc: The connection.
- * @state: The connection state.
*/
void purple_connection_set_state(PurpleConnection *gc, PurpleConnectionState state);
/**
- * Sets the connection flags.
- *
+ * purple_connection_set_flags:
* @gc: The connection.
* @flags: The flags.
+ *
+ * Sets the connection flags.
*/
void purple_connection_set_flags(PurpleConnection *gc, PurpleConnectionFlags flags);
/**
- * Sets the connection's displayed name.
- *
+ * purple_connection_set_display_name:
* @gc: The connection.
* @name: The displayed name.
+ *
+ * Sets the connection's displayed name.
More information about the Commits
mailing list