changeset
Fix cross-references and some other warnings
Thu, 06 Feb 2014 16:19:47 +0530
- author
- Ankit Vani <a@nevitus.org>
- date
- Thu, 06 Feb 2014 16:19:47 +0530
- branch
- gtkdoc-conversion
- changeset 35467
- 975ae62dd895
- parent 35466
- e259e75f1c6f
- child 35468
- 65e7b4566de4
Fix cross-references and some other warnings
--- a/libpurple/account.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/account.h Thu Feb 06 16:19:47 2014 +0530 @@ -343,7 +343,7 @@ * * 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 @@ * @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 @@ /** * 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 @@ * * 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 @@ * * 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 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,
--- a/libpurple/certificate.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/certificate.h Thu Feb 06 16:19:47 2014 +0530 @@ -296,7 +296,7 @@ * @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. *
--- a/libpurple/connection.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/connection.h Thu Feb 06 16:19:47 2014 +0530 @@ -43,6 +43,8 @@ typedef struct _PurpleConnectionUiOps PurpleConnectionUiOps; +typedef struct _PurpleConnectionErrorInfo PurpleConnectionErrorInfo; + /** * PurpleConnectionFlags: * @PURPLE_CONNECTION_FLAG_HTML: Connection sends/receives in 'HTML' @@ -177,11 +179,11 @@ * * Holds the type of an error along with its description. */ -typedef struct +struct _PurpleConnectionErrorInfo { PurpleConnectionError type; char *description; -} PurpleConnectionErrorInfo; +}; #include <time.h>
--- a/libpurple/conversation.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/conversation.h Thu Feb 06 16:19:47 2014 +0530 @@ -205,10 +205,10 @@ * @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
--- a/libpurple/dbus-server.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/dbus-server.h Thu Feb 06 16:19:47 2014 +0530 @@ -156,7 +156,7 @@ * 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 @@ * 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);
--- a/libpurple/debug.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/debug.h Thu Feb 06 16:19:47 2014 +0530 @@ -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 @@ * * Debug UI operations. */ -typedef struct +struct _PurpleDebugUiOps { void (*print)(PurpleDebugLevel level, const char *category, const char *arg_s); @@ -70,7 +72,7 @@ void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); -} PurpleDebugUiOps; +}; G_BEGIN_DECLS
--- a/libpurple/enums.h.in Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/enums.h.in Thu Feb 06 16:19:47 2014 +0530 @@ -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
--- a/libpurple/eventloop.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/eventloop.h Thu Feb 06 16:19:47 2014 +0530 @@ -240,7 +240,7 @@ * 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);
--- a/libpurple/idle.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/idle.h Thu Feb 06 16:19:47 2014 +0530 @@ -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 @@ void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); -} PurpleIdleUiOps; +}; G_BEGIN_DECLS
--- a/libpurple/media/backend-iface.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/media/backend-iface.h Thu Feb 06 16:19:47 2014 +0530 @@ -56,9 +56,11 @@ 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,
--- a/libpurple/notify.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/notify.h Thu Feb 06 16:19:47 2014 +0530 @@ -48,6 +48,9 @@ #include "connection.h" #include "request.h" +typedef struct _PurpleNotifySearchResults PurpleNotifySearchResults; + +typedef struct _PurpleNotifyUiOps PurpleNotifyUiOps; /** * PurpleNotifyCloseCallback: @@ -126,13 +129,13 @@ * * Search results object. */ -typedef struct +struct _PurpleNotifySearchResults { GList *columns; GList *rows; GList *buttons; -} PurpleNotifySearchResults; +}; /** * PurpleNotifyUserInfoEntryType: @@ -180,7 +183,7 @@ * * 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 @@ void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); -} PurpleNotifyUiOps; +}; G_BEGIN_DECLS
--- a/libpurple/plugin.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/plugin.h Thu Feb 06 16:19:47 2014 +0530 @@ -621,7 +621,7 @@ * * Probes for plugins in the registered module paths. * - * @see purple_plugin_set_probe_path() + * See purple_plugins_add_search_path(). */ void purple_plugins_probe(const char *ext);
--- a/libpurple/sound.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/sound.h Thu Feb 06 16:19:47 2014 +0530 @@ -34,7 +34,7 @@ /**************************************************************************/ /** Data Structures */ /**************************************************************************/ - +typedef struct _PurpleSoundUiOps PurpleSoundUiOps; /** * PurpleSoundEventID: @@ -79,7 +79,7 @@ * Operations used by the core to request that particular sound files, or the * sound associated with a particular event, should be played. */ -typedef struct _PurpleSoundUiOps +struct _PurpleSoundUiOps { void (*init)(void); void (*uninit)(void); @@ -91,7 +91,7 @@ void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); -} PurpleSoundUiOps; +}; G_BEGIN_DECLS
--- a/libpurple/sslconn.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/sslconn.h Thu Feb 06 16:19:47 2014 +0530 @@ -57,10 +57,10 @@ * PurpleSslConnection: * @host: Hostname to which the SSL connection will be made * @port: Port to connect to - * @connect_cb_data: Data to pass to PurpleSslConnection::connect_cb() + * @connect_cb_data: Data to pass to @connect_cb * @connect_cb: Callback triggered once the SSL handshake is complete * @error_cb: Callback triggered if there is an error during connection - * @recv_cb_data: Data passed to PurpleSslConnection::recv_cb() + * @recv_cb_data: Data passed to @recv_cb * @recv_cb: User-defined callback executed when the SSL connection * receives data * @fd: File descriptor used to refer to the socket
--- a/libpurple/upnp.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/upnp.h Thu Feb 06 16:19:47 2014 +0530 @@ -109,7 +109,8 @@ * this purple client. Essentially, this function takes care of the port * forwarding so things like file transfers can work behind NAT firewalls * - * Returns: Data which can be passed to purple_upnp_port_mapping_cancel() to cancel + * Returns: Data which can be passed to purple_upnp_cancel_port_mapping() to + * cancel */ UPnPMappingAddRemove *purple_upnp_set_port_mapping(unsigned short portmap, const gchar* protocol, PurpleUPnPCallback cb, gpointer cb_data); @@ -127,7 +128,8 @@ * port forwarding after they have completed a connection so another client on * the local network can take advantage of the port forwarding * - * Returns: Data which can be passed to purple_upnp_port_mapping_cancel() to cancel + * Returns: Data which can be passed to purple_upnp_cancel_port_mapping() to + * cancel */ UPnPMappingAddRemove *purple_upnp_remove_port_mapping(unsigned short portmap, const gchar* protocol, PurpleUPnPCallback cb, gpointer cb_data);
--- a/libpurple/util.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/util.h Thu Feb 06 16:19:47 2014 +0530 @@ -398,16 +398,16 @@ * This is essentially strftime(), but it has a static buffer * and handles the UTF-8 conversion for the caller. * - * This function also provides the GNU %z formatter if the underlying C + * This function also provides the GNU \%z formatter if the underlying C * library doesn't. However, the format string parser is very naive, which - * means that conversions specifiers to %z cannot be guaranteed. The GNU - * strftime(3) man page describes %z as: 'The time-zone as hour offset from + * means that conversions specifiers to \%z cannot be guaranteed. The GNU + * strftime(3) man page describes \%z as: 'The time-zone as hour offset from * GMT. Required to emit RFC822-conformant dates - * (using "%a, %d %b %Y %H:%M:%S %z"). (GNU)' + * (using "\%a, \%d \%b \%Y \%H:\%M:\%S \%z"). (GNU)' * - * On Windows, this function also converts the results for %Z from a timezone - * name (as returned by the system strftime() %Z format string) to a timezone - * abbreviation (as is the case on Unix). As with %z, conversion specifiers + * On Windows, this function also converts the results for \%Z from a timezone + * name (as returned by the system strftime() \%Z format string) to a timezone + * abbreviation (as is the case on Unix). As with \%z, conversion specifiers * should not be used. * * Note: @format is required to be in UTF-8. This differs from strftime(), @@ -534,7 +534,7 @@ /** * purple_uts35_to_str: - * @format: The formatting string, according to UTS #35 + * @format: The formatting string, according to UTS \#35 * See http://unicode.org/reports/tr35/ * (NOTE: not all formats are supported) * @len: The length of the formatting string @@ -1441,8 +1441,8 @@ * purple_gai_strerror: * @errnum: The error code. * - * Return the UTF-8 version of gai_strerror(). It calls gai_strerror() - * then converts the result to UTF-8. This function is analogous to + * Return the UTF-8 version of #gai_strerror. It calls #gai_strerror + * then converts the result to UTF-8. This function is analogous to * g_strerror(). * * Returns: The UTF-8 error message. @@ -1654,7 +1654,7 @@ * @nonce: The nonce provided by the server * @nonce_count: The nonce count * @client_nonce: The nonce provided by the client - * @session_key: The session key from purple_cipher_http_digest_calculate_session_key() + * @session_key: The session key from purple_http_digest_calculate_session_key() * * Calculate a response for HTTP Digest authentication *
--- a/libpurple/whiteboard.h Thu Feb 06 03:04:43 2014 +0530 +++ b/libpurple/whiteboard.h Thu Feb 06 16:19:47 2014 +0530 @@ -38,50 +38,66 @@ typedef struct _PurpleWhiteboard PurpleWhiteboard; typedef struct _PurpleWhiteboardClass PurpleWhiteboardClass; +typedef struct _PurpleWhiteboardUiOps PurpleWhiteboardUiOps; typedef struct _PurpleWhiteboardPrplOps PurpleWhiteboardPrplOps; #include "account.h" /** * PurpleWhiteboardUiOps: + * @create: create whiteboard + * @destroy: destory whiteboard + * @set_dimensions: set whiteboard dimensions + * @set_brush: set the size and color of the brush + * @draw_point: draw a point + * @draw_line: draw a line + * @clear: clear whiteboard * * The PurpleWhiteboard UI Operations */ -typedef struct _PurpleWhiteboardUiOps +struct _PurpleWhiteboardUiOps { - void (*create)(PurpleWhiteboard *wb); /**< create function */ - void (*destroy)(PurpleWhiteboard *wb); /**< destory function */ - void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); /**< set_dimensions function */ - void (*set_brush) (PurpleWhiteboard *wb, int size, int color); /**< set the size and color of the brush */ + void (*create)(PurpleWhiteboard *wb); + void (*destroy)(PurpleWhiteboard *wb); + void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); + void (*set_brush) (PurpleWhiteboard *wb, int size, int color); void (*draw_point)(PurpleWhiteboard *wb, int x, int y, - int color, int size); /**< draw_point function */ + int color, int size); void (*draw_line)(PurpleWhiteboard *wb, int x1, int y1, int x2, int y2, - int color, int size); /**< draw_line function */ - void (*clear)(PurpleWhiteboard *wb); /**< clear function */ + int color, int size); + void (*clear)(PurpleWhiteboard *wb); /*< private >*/ void (*_purple_reserved1)(void); void (*_purple_reserved2)(void); void (*_purple_reserved3)(void); void (*_purple_reserved4)(void); -} PurpleWhiteboardUiOps; +}; /** * PurpleWhiteboardPrplOps: + * @start: start function + * @end: end function + * @get_dimensions: get whiteboard dimensions + * @set_dimensions: set whiteboard dimensions + * @get_brush: get the brush size and color + * @set_brush: set the brush size and color + * @send_draw_list: send_draw_list function + * @clear: clear whiteboard * * Whiteboard protocol operations */ struct _PurpleWhiteboardPrplOps { - void (*start)(PurpleWhiteboard *wb); /**< start function */ - void (*end)(PurpleWhiteboard *wb); /**< end function */ - void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height); /**< get_dimensions function */ - void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); /**< set_dimensions function */ - void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color); /**< get the brush size and color */ - void (*set_brush) (PurpleWhiteboard *wb, int size, int color); /**< set the brush size and color */ - void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list); /**< send_draw_list function */ - void (*clear)(PurpleWhiteboard *wb); /**< clear function */ + void (*start)(PurpleWhiteboard *wb); + void (*end)(PurpleWhiteboard *wb); + void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height); + void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height); + void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color); + void (*set_brush) (PurpleWhiteboard *wb, int size, int color); + void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list); + void (*clear)(PurpleWhiteboard *wb); /*< private >*/ void (*_purple_reserved1)(void);
