/soc/2013/ankitkv/gobjectification: 975ae62dd895: Fix cross-refe...
Ankit Vani
a at nevitus.org
Thu Feb 6 06:24:49 EST 2014
Changeset: 975ae62dd895e74b7d9ff9d7339e968aca31a796
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-06 16:19 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/975ae62dd895
Description:
Fix cross-references and some other warnings
diffstat:
libpurple/account.h | 19 ++++++---------
libpurple/certificate.h | 2 +-
libpurple/connection.h | 6 +++-
libpurple/conversation.h | 4 +-
libpurple/dbus-server.h | 8 +++---
libpurple/debug.h | 6 +++-
libpurple/enums.h.in | 2 +-
libpurple/eventloop.h | 2 +-
libpurple/idle.h | 6 +++-
libpurple/media/backend-iface.h | 6 +++-
libpurple/notify.h | 11 +++++---
libpurple/plugin.h | 2 +-
libpurple/sound.h | 6 ++--
libpurple/sslconn.h | 4 +-
libpurple/upnp.h | 6 +++-
libpurple/util.h | 22 +++++++++---------
libpurple/whiteboard.h | 50 +++++++++++++++++++++++++++-------------
17 files changed, 94 insertions(+), 68 deletions(-)
diffs (truncated from 517 to 300 lines):
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -343,7 +343,7 @@ void purple_account_set_username(PurpleA
*
* The password in the keyring might not be immediately updated, but the cached
* version will be, and it is therefore safe to read the password back before
- * the callback has been triggered. One can also set a NULL callback if
+ * the callback has been triggered. One can also set a %NULL callback if
* notification of saving to the keyring is not required.
*/
void purple_account_set_password(PurpleAccount *account, const gchar *password,
@@ -458,7 +458,7 @@ void purple_account_set_status_types(Pur
* @status_id: The ID of the status.
* @active: Whether @a status_id is to be activated (%TRUE) or
* deactivated (%FALSE).
- * @...: A NULL-terminated list of pairs of <type>const char *</type>
+ * @...: A %NULL-terminated list of pairs of <type>const char *</type>
* attribute name followed by <type>const char *</type> attribute
* value for the status. (For example, one pair might be
* <literal>"message"</literal> followed by
@@ -494,13 +494,13 @@ void purple_account_set_status_list(Purp
/**
* purple_account_set_public_alias:
* @account: The account
- * @alias: The new public alias for this account or NULL
+ * @alias: The new public alias for this account or %NULL
* to unset the alias/nickname (or return it to
* a protocol-specific "default", like the username)
* @success_cb: A callback which will be called if the alias
- * is successfully set on the server (or NULL).
+ * is successfully set on the server (or %NULL).
* @failure_cb: A callback which will be called if the alias
- * is not successfully set on the server (or NULL).
+ * is not successfully set on the server (or %NULL).
*
* Set a server-side (public) alias for this account. The account
* must already be connected.
@@ -993,10 +993,7 @@ PurpleStatus *purple_account_get_active_
*
* Returns the account status with the specified ID.
*
- * Note that this works differently than purple_buddy_get_status() in that
- * it will only return NULL if the status was not registered.
- *
- * Returns: The status, or NULL if it was never registered.
+ * Returns: The status, or %NULL if it was never registered.
*/
PurpleStatus *purple_account_get_status(const PurpleAccount *account,
const char *status_id);
@@ -1008,7 +1005,7 @@ PurpleStatus *purple_account_get_status(
*
* Returns the account status type with the specified ID.
*
- * Returns: The status type if found, or NULL.
+ * Returns: The status type if found, or %NULL.
*/
PurpleStatusType *purple_account_get_status_type(const PurpleAccount *account,
const char *id);
@@ -1023,7 +1020,7 @@ PurpleStatusType *purple_account_get_sta
* PurpleStatusType with the same primitive. In this case, the
* first PurpleStatusType is returned.
*
- * Returns: The status if found, or NULL.
+ * Returns: The status if found, or %NULL.
*/
PurpleStatusType *purple_account_get_status_type_with_primitive(
const PurpleAccount *account,
diff --git a/libpurple/certificate.h b/libpurple/certificate.h
--- a/libpurple/certificate.h
+++ b/libpurple/certificate.h
@@ -296,7 +296,7 @@ struct _PurpleCertificateScheme
* @destroy_request: Destroy a completed Request under this Verifier. The
* function pointed to here is only responsible for
* cleaning up whatever
- * #PurpleCertificateVerificationRequest::data points to.
+ * #PurpleCertificateVerificationRequest.data points to.
* It should not call free(@vrq).
* <sbr/>@vrq: The request to destroy.
*
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -43,6 +43,8 @@ typedef struct _PurpleConnectionClass Pu
typedef struct _PurpleConnectionUiOps PurpleConnectionUiOps;
+typedef struct _PurpleConnectionErrorInfo PurpleConnectionErrorInfo;
+
/**
* PurpleConnectionFlags:
* @PURPLE_CONNECTION_FLAG_HTML: Connection sends/receives in 'HTML'
@@ -177,11 +179,11 @@ typedef enum
*
* Holds the type of an error along with its description.
*/
-typedef struct
+struct _PurpleConnectionErrorInfo
{
PurpleConnectionError type;
char *description;
-} PurpleConnectionErrorInfo;
+};
#include <time.h>
diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -205,10 +205,10 @@ struct _PurpleConversationClass {
* @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().
+ * See purple_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().
+ * See purple_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
diff --git a/libpurple/dbus-server.h b/libpurple/dbus-server.h
--- a/libpurple/dbus-server.h
+++ b/libpurple/dbus-server.h
@@ -156,7 +156,7 @@ void purple_dbus_signal_emit_purple(cons
* purple_dbus_get_init_error:
*
* Returns whether Purple's D-BUS subsystem is up and running. If it's
- * NOT running then purple_dbus_dispatch_init() failed for some reason,
+ * NOT running then #purple_dbus_dispatch_init failed for some reason,
* and a message should have been purple_debug_error()'ed.
*
* Purple plugins that use D-BUS should use the
@@ -164,9 +164,9 @@ void purple_dbus_signal_emit_purple(cons
* initialization if Purple's D-BUS subsystem is not running.
*
* Returns: If the D-BUS subsystem started with no problems then this
- * will return NULL and everything will be hunky dory. If
- * there was an error initializing the D-BUS subsystem then
- * this will return an error message explaining why.
+ * will return NULL and everything will be hunky dory. If
+ * there was an error initializing the D-BUS subsystem then
+ * this will return an error message explaining why.
*/
const char *purple_dbus_get_init_error(void);
diff --git a/libpurple/debug.h b/libpurple/debug.h
--- a/libpurple/debug.h
+++ b/libpurple/debug.h
@@ -31,6 +31,8 @@
#include <glib.h>
#include <stdarg.h>
+typedef struct _PurpleDebugUiOps PurpleDebugUiOps;
+
/**
* PurpleDebugLevel:
* @PURPLE_DEBUG_ALL: All debug levels.
@@ -58,7 +60,7 @@ typedef enum
*
* Debug UI operations.
*/
-typedef struct
+struct _PurpleDebugUiOps
{
void (*print)(PurpleDebugLevel level, const char *category,
const char *arg_s);
@@ -70,7 +72,7 @@ typedef struct
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
-} PurpleDebugUiOps;
+};
G_BEGIN_DECLS
diff --git a/libpurple/enums.h.in b/libpurple/enums.h.in
--- a/libpurple/enums.h.in
+++ b/libpurple/enums.h.in
@@ -25,7 +25,7 @@
* @short_description: <filename>enums.h</filename>
* @title: GEnums and GFlags
*
- * This file contains all the #GEnum and #GFlag type definitions of libpurple.
+ * This file contains all the #GEnum and #GFlags type definitions of libpurple.
*/
#ifndef PURPLE_ENUMS_H
diff --git a/libpurple/eventloop.h b/libpurple/eventloop.h
--- a/libpurple/eventloop.h
+++ b/libpurple/eventloop.h
@@ -240,7 +240,7 @@ gboolean purple_input_remove(guint handl
* implement the input_get_error UI op.
*
* Returns: 0 if there is no error; -1 if there is an error, in which case
- * %errno will be set.
+ * #errno will be set.
*/
int
purple_input_get_error(int fd, int *error);
diff --git a/libpurple/idle.h b/libpurple/idle.h
--- a/libpurple/idle.h
+++ b/libpurple/idle.h
@@ -30,12 +30,14 @@
#include <time.h>
+typedef struct _PurpleIdleUiOps PurpleIdleUiOps;
+
/**
* PurpleIdleUiOps:
*
* Idle UI operations.
*/
-typedef struct
+struct _PurpleIdleUiOps
{
time_t (*get_time_idle)(void);
@@ -44,7 +46,7 @@ typedef struct
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
-} PurpleIdleUiOps;
+};
G_BEGIN_DECLS
diff --git a/libpurple/media/backend-iface.h b/libpurple/media/backend-iface.h
--- a/libpurple/media/backend-iface.h
+++ b/libpurple/media/backend-iface.h
@@ -56,9 +56,11 @@ typedef struct _PurpleMediaBackendIface
struct _PurpleMediaBackendIface
{
- GTypeInterface parent_iface; /**< The parent iface class */
+ /*< private >*/
+ GTypeInterface parent_iface; /* The parent iface class */
- /** Implementable functions called with purple_media_backend_* */
+ /*< public >*/
+ /* Implementable functions called with purple_media_backend_* */
gboolean (*add_stream) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *who,
PurpleMediaSessionType type, gboolean initiator,
diff --git a/libpurple/notify.h b/libpurple/notify.h
--- a/libpurple/notify.h
+++ b/libpurple/notify.h
@@ -48,6 +48,9 @@ typedef struct _PurpleNotifySearchColumn
#include "connection.h"
#include "request.h"
+typedef struct _PurpleNotifySearchResults PurpleNotifySearchResults;
+
+typedef struct _PurpleNotifyUiOps PurpleNotifyUiOps;
/**
* PurpleNotifyCloseCallback:
@@ -126,13 +129,13 @@ typedef enum
*
* Search results object.
*/
-typedef struct
+struct _PurpleNotifySearchResults
{
GList *columns;
GList *rows;
GList *buttons;
-} PurpleNotifySearchResults;
+};
/**
* PurpleNotifyUserInfoEntryType:
@@ -180,7 +183,7 @@ typedef struct
*
* Notification UI operations.
*/
-typedef struct
+struct _PurpleNotifyUiOps
{
void *(*notify_message)(PurpleNotifyMsgType type, const char *title,
const char *primary, const char *secondary,
@@ -218,7 +221,7 @@ typedef struct
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
-} PurpleNotifyUiOps;
+};
G_BEGIN_DECLS
diff --git a/libpurple/plugin.h b/libpurple/plugin.h
--- a/libpurple/plugin.h
+++ b/libpurple/plugin.h
@@ -621,7 +621,7 @@ void purple_plugins_load_saved(const cha
*
* Probes for plugins in the registered module paths.
*
More information about the Commits
mailing list