/soc/2013/ankitkv/gobjectification: 197d965cec97: Fix gtk-doc wa...
Ankit Vani
a at nevitus.org
Fri Feb 7 07:45:14 EST 2014
Changeset: 197d965cec973f8c5bef4d2d172cb307e1cfaa99
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-07 17:12 +0530
Branch: soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/197d965cec97
Description:
Fix gtk-doc warnings
diffstat:
libpurple/conversation.h | 2 +-
libpurple/plugins.h | 4 ++--
libpurple/protocol.h | 28 +++++++++++++++-------------
libpurple/protocols.h | 6 +++---
4 files changed, 21 insertions(+), 19 deletions(-)
diffs (115 lines):
diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -719,7 +719,7 @@ gboolean purple_conversation_do_command(
*
* Gets the maximum message size in bytes for the conversation.
*
- * See #PurpleProtocolClientIface.get_max_message_size
+ * See #PurpleProtocolClientIface's <literal>get_max_message_size</literal>.
*
* Returns: Maximum message size, 0 if unspecified, -1 for infinite.
*/
diff --git a/libpurple/plugins.h b/libpurple/plugins.h
--- a/libpurple/plugins.h
+++ b/libpurple/plugins.h
@@ -605,8 +605,8 @@ GType purple_plugin_info_get_type(void);
* <row><entry><literal>"license-id"</literal></entry>
* <entry>(string) Short name of the plugin's license. This should
* either be an identifier of the license from
- * <ulink url="http://dep.debian.net/deps/dep5/#license-specification" />
- * or "Other" for custom licenses.</entry>
+ * <ulink url="http://dep.debian.net/deps/dep5/#license-specification">
+ * DEP5</ulink> or "Other" for custom licenses.</entry>
* </row>
* <row><entry><literal>"license-text"</literal></entry>
* <entry>(string) The text of the plugin's license, if unlisted on
diff --git a/libpurple/protocol.h b/libpurple/protocol.h
--- a/libpurple/protocol.h
+++ b/libpurple/protocol.h
@@ -272,7 +272,7 @@ typedef struct _PurpleProtocolServerIfac
* protocol's active connections. You'd want to do this if you
* need to repeatedly send some kind of keepalive packet to
* the server to avoid being disconnected. ("Regularly" is
- * defined by #KEEPALIVE_INTERVAL in
+ * defined by <literal>KEEPALIVE_INTERVAL</literal> in
* <filename>libpurple/connection.c</filename>.)
* @alias_buddy: Save/store buddy's alias on server list/roster
* @group_buddy: Change a buddy's group on a server list/roster
@@ -387,12 +387,13 @@ typedef struct _PurpleProtocolIMIface Pu
/**
* PurpleProtocolIMIface:
* @send: This protocol function should return a positive value on
- * success. If the message is too big to be sent, return -#E2BIG.
- * If the account is not connected, return -#ENOTCONN. If the
- * protocol is unable to send the message for another reason,
- * return some other negative value. You can use one of the valid
- * #errno values, or just big something. If the message should not
- * be echoed to the conversation window, return 0.
+ * success. If the message is too big to be sent, return
+ * <literal>-E2BIG</literal>. If the account is not connected,
+ * return <literal>-ENOTCONN</literal>. If the protocol is unable
+ * to send the message for another reason, return some other
+ * negative value. You can use one of the valid #errno values, or
+ * just big something. If the message should not be echoed to the
+ * conversation window, return 0.
* @send_typing: If this protocol requires the #PURPLE_IM_TYPING message to be
* sent repeatedly to signify that the user is still typing, then
* the protocol should return the number of seconds to wait before
@@ -467,11 +468,12 @@ typedef struct _PurpleProtocolChatIface
* <sbr/>@message: The message of the whisper.
* @send: Send a message to a chat.
* <sbr/>This protocol function should return a positive value on
- * success. If the message is too big to be sent, return -#E2BIG.
- * If the account is not connected, return -#ENOTCONN. If the
- * protocol is unable to send the message for another reason,
- * return some other negative value. You can use one of the valid
- * #errno values, or just big something.
+ * success. If the message is too big to be sent, return
+ * <literal>-E2BIG</literal>. If the account is not connected,
+ * return <literal>-ENOTCONN</literal>. If the protocol is unable
+ * to send the message for another reason, return some other
+ * negative value. You can use one of the valid #errno values, or
+ * just big something.
* <sbr/>@id: The id of the chat to send the message to.
* <sbr/>@message: The message to send to the chat.
* <sbr/>@flags: A bitwise OR of #PurpleMessageFlags representing
@@ -726,7 +728,7 @@ struct _PurpleProtocolFactoryIface
/**
* PURPLE_PROTOCOL_IMPLEMENTS:
* @protocol: The protocol in which to check
- * @IFACE: The interface name in caps. e.g. #CLIENT_IFACE
+ * @IFACE: The interface name in caps. e.g. <literal>CLIENT_IFACE</literal>
* @func: The function to check
*
* Returns: %TRUE if a protocol implements a function in an interface,
diff --git a/libpurple/protocols.h b/libpurple/protocols.h
--- a/libpurple/protocols.h
+++ b/libpurple/protocols.h
@@ -386,7 +386,7 @@ void purple_protocol_got_account_login_t
* @account: The account the user is on.
* @status_id: The status ID.
* @...: A NULL-terminated list of attribute IDs and values,
- * beginning with the value for #attr_id.
+ * beginning with the value for <literal>attr_id</literal>.
*
* Notifies Purple that our account's status has changed.
*
@@ -446,7 +446,7 @@ void purple_protocol_got_user_login_time
* @name: The name of the buddy.
* @status_id: The status ID.
* @...: A NULL-terminated list of attribute IDs and values,
- * beginning with the value for %attr_id.
+ * beginning with the value for <literal>attr_id</literal>.
*
* Notifies Purple that a buddy's status has been activated.
*
@@ -583,7 +583,7 @@ void purple_protocol_got_media_caps(Purp
*
* Gets the safe maximum message size in bytes for the protocol.
*
- * See #PurpleProtocolClientIface.get_max_message_size
+ * See #PurpleProtocolClientIface's <literal>get_max_message_size</literal>.
*
* Returns: Maximum message size, 0 if unspecified, -1 for infinite.
*/
More information about the Commits
mailing list