Fix gtk-doc warnings soc.2013.gobjectification.plugins

Fri, 07 Feb 2014 17:12:13 +0530

author
Ankit Vani <a@nevitus.org>
date
Fri, 07 Feb 2014 17:12:13 +0530
branch
soc.2013.gobjectification.plugins
changeset 37087
197d965cec97
parent 37086
b78048ba0fbb
child 37088
4d5ad6b1878e

Fix gtk-doc warnings

libpurple/conversation.h file | annotate | diff | comparison | revisions
libpurple/plugins.h file | annotate | diff | comparison | revisions
libpurple/protocol.h file | annotate | diff | comparison | revisions
libpurple/protocols.h file | annotate | diff | comparison | revisions
--- a/libpurple/conversation.h	Fri Feb 07 16:46:21 2014 +0530
+++ b/libpurple/conversation.h	Fri Feb 07 17:12:13 2014 +0530
@@ -719,7 +719,7 @@
  *
  * 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.
  */
--- a/libpurple/plugins.h	Fri Feb 07 16:46:21 2014 +0530
+++ b/libpurple/plugins.h	Fri Feb 07 17:12:13 2014 +0530
@@ -605,8 +605,8 @@
  *   <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
--- a/libpurple/protocol.h	Fri Feb 07 16:46:21 2014 +0530
+++ b/libpurple/protocol.h	Fri Feb 07 17:12:13 2014 +0530
@@ -272,7 +272,7 @@
  *                   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 @@
 /**
  * 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 @@
  *           <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 @@
 /**
  * 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,
--- a/libpurple/protocols.h	Fri Feb 07 16:46:21 2014 +0530
+++ b/libpurple/protocols.h	Fri Feb 07 17:12:13 2014 +0530
@@ -386,7 +386,7 @@
  * @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 @@
  * @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 @@
  *
  * 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.
  */

mercurial