changeset
Fix HTML generation warnings by using DocBook tags
Thu, 06 Feb 2014 16:46:43 +0530
- author
- Ankit Vani <a@nevitus.org>
- date
- Thu, 06 Feb 2014 16:46:43 +0530
- branch
- gtkdoc-conversion
- changeset 35468
- 65e7b4566de4
- parent 35467
- 975ae62dd895
- child 35469
- 768de721115c
Fix HTML generation warnings by using DocBook tags
| libpurple/cmds.h | file | annotate | diff | comparison | revisions | |
| libpurple/dbus-maybe.h | file | annotate | diff | comparison | revisions | |
| libpurple/eventloop.h | file | annotate | diff | comparison | revisions | |
| libpurple/prpl.h | file | annotate | diff | comparison | revisions | |
| libpurple/request.h | file | annotate | diff | comparison | revisions | |
| libpurple/sslconn.h | file | annotate | diff | comparison | revisions | |
| libpurple/util.h | file | annotate | diff | comparison | revisions | |
| libpurple/xfer.h | file | annotate | diff | comparison | revisions | |
| libpurple/xmlnode.h | file | annotate | diff | comparison | revisions |
--- a/libpurple/cmds.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/cmds.h Thu Feb 06 16:46:43 2014 +0530 @@ -141,18 +141,18 @@ * the flag #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed in @f. * This string should contain no whitespace, and use a single * character for each argument. The recognized characters are: - * <ul> - * <li><literal>'w'</literal>: Matches a single word.</li> - * <li><literal>'W'</literal>: Matches a single word, with - * formatting.</li> - * <li><literal>'s'</literal>: Matches the rest of the arguments - * after this point, as a single - * string.</li> - * <li><literal>'S'</literal>: Same as <literal>'s'</literal> but - * with formatting.</li> - * </ul> - * If args is the empty string, then the command accepts no arguments. - * The args passed to the callback @func will be a %NULL + * <itemizedlist> + * <listitem><literal>'w'</literal>: Matches a single word.</listitem> + * <listitem><literal>'W'</literal>: Matches a single word, with + * formatting.</listitem> + * <listitem><literal>'s'</literal>: Matches the rest of the + * arguments after this point, + * as a single string.</listitem> + * <listitem><literal>'S'</literal>: Same as <literal>'s'</literal> + * but with formatting.</listitem> + * </itemizedlist> + * If args is the empty string, then the command accepts no + * arguments. The args passed to the callback @func will be a %NULL * terminated array of %NULL terminated strings, and will always * match the number of arguments asked for, unless * #PURPLE_CMD_FLAG_ALLOW_WRONG_ARGS is passed.
--- a/libpurple/dbus-maybe.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/dbus-maybe.h Thu Feb 06 16:46:43 2014 +0530 @@ -35,7 +35,6 @@ } #define PURPLE_DBUS_UNREGISTER_POINTER(ptr) -#define DBUS_EXPORT #endif /* HAVE_DBUS */
--- a/libpurple/eventloop.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/eventloop.h Thu Feb 06 16:46:43 2014 +0530 @@ -221,7 +221,8 @@ /** * purple_input_remove: * @handle: The handle of the input handler. Note that this is the return - * value from purple_input_add(), <i>not</i> the file descriptor. + * value from purple_input_add(), <emphasis>not</emphasis> the + * file descriptor. * * Removes an input handler. */
--- a/libpurple/prpl.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/prpl.h Thu Feb 06 16:46:43 2014 +0530 @@ -146,31 +146,31 @@ /** * PurpleProtocolOptions: * @OPT_PROTO_UNIQUE_CHATNAME: User names are unique to a chat and are not - * shared between rooms.<br/> + * shared between rooms.<sbr/> * XMPP lets you choose what name you want in chats, so it shouldn't * be pulling the aliases from the buddy list for the chat list; it * gets annoying. - * @OPT_PROTO_CHAT_TOPIC: Chat rooms have topics.<br/> + * @OPT_PROTO_CHAT_TOPIC: Chat rooms have topics.<sbr/> * IRC and XMPP support this. - * @OPT_PROTO_NO_PASSWORD: Don't require passwords for sign-in.<br/> + * @OPT_PROTO_NO_PASSWORD: Don't require passwords for sign-in.<sbr/> * Zephyr doesn't require passwords, so there's no need for a * password prompt. - * @OPT_PROTO_MAIL_CHECK: Notify on new mail.<br/> + * @OPT_PROTO_MAIL_CHECK: Notify on new mail.<sbr/> * MSN and Yahoo notify you when you have new mail. - * @OPT_PROTO_IM_IMAGE: Images in IMs.<br/> + * @OPT_PROTO_IM_IMAGE: Images in IMs.<sbr/> * Oscar lets you send images in direct IMs. - * @OPT_PROTO_PASSWORD_OPTIONAL: Allow passwords to be optional.<br/> + * @OPT_PROTO_PASSWORD_OPTIONAL: Allow passwords to be optional.<sbr/> * Passwords in IRC are optional, and are needed for certain * functionality. * @OPT_PROTO_USE_POINTSIZE: Allows font size to be specified in sane point - * size.<br/> + * size.<sbr/> * Probably just XMPP and Y!M * @OPT_PROTO_REGISTER_NOSCREENNAME: Set the Register button active even when - * the username has not been specified.<br/> + * the username has not been specified.<sbr/> * Gadu-Gadu doesn't need a username to register new account (because * usernames are assigned by the server). * @OPT_PROTO_SLASH_COMMANDS_NATIVE: Indicates that slash commands are native - * to this protocol.<br/> + * to this protocol.<sbr/> * Used as a hint that unknown commands should not be sent as * messages. * @OPT_PROTO_INVITE_MESSAGE: Indicates that this protocol supports sending a
--- a/libpurple/request.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/request.h Thu Feb 06 16:46:43 2014 +0530 @@ -1929,9 +1929,9 @@ * because it allows a request to be closed with * purple_request_close_with_handle() when, for * example, you sign offline. If the request is - * <emphasis>not</emphasis> closed it is <strong>very</strong> - * likely to cause a crash whenever the callback - * handler functions are triggered. + * <emphasis>not</emphasis> closed it is + * <emphasis>very</emphasis> likely to cause a crash whenever + * the callback handler functions are triggered. * @title: The title of the message, or %NULL if it should have * no title. * @primary: The main point of the message, or %NULL if you're
--- a/libpurple/sslconn.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/sslconn.h Thu Feb 06 16:46:43 2014 +0530 @@ -178,9 +178,9 @@ * @port: The destination port. * @func: The SSL input handler function. * @error_func: The SSL error handler function. This function - * should <strong>NOT</strong> call purple_ssl_close(). In - * the event of an error the #PurpleSslConnection will be - * destroyed for you. + * should <emphasis>NOT</emphasis> call purple_ssl_close(). In + * the event of an error the #PurpleSslConnection will be + * destroyed for you. * @data: User-defined data. * * Makes a SSL connection to the specified host and port. The caller @@ -201,9 +201,9 @@ * @port: The destination port. * @func: The SSL input handler function. * @error_func: The SSL error handler function. This function - * should <strong>NOT</strong> call purple_ssl_close(). In - * the event of an error the #PurpleSslConnection will be - * destroyed for you. + * should <emphasis>NOT</emphasis> call purple_ssl_close(). In + * the event of an error the #PurpleSslConnection will be + * destroyed for you. * @ssl_host: The hostname of the other peer (to verify the CN) * @data: User-defined data. *
--- a/libpurple/util.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/util.h Thu Feb 06 16:46:43 2014 +0530 @@ -649,8 +649,8 @@ * Adds the necessary HTML code to turn URIs into HTML links in a string. * * Returns: The new string with all URIs surrounded in standard - * HTML <a href="whatever"></a> tags. You must g_free this - * string when finished with it. + * HTML <a href="whatever"></a> tags. You must g_free() + * this string when finished with it. */ char *purple_markup_linkify(const char *str); @@ -1039,7 +1039,7 @@ * Normalizes a string, so that it is suitable for comparison. * * The returned string will point to a static buffer, so if the - * string is intended to be kept long-term, you <i>must</i> + * string is intended to be kept long-term, you <emphasis>must</emphasis> * g_strdup() it. Also, calling normalize() twice in the same line * will lead to problems. *
--- a/libpurple/xfer.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/xfer.h Thu Feb 06 16:46:43 2014 +0530 @@ -693,7 +693,7 @@ * * Starts a file transfer. * - * Either @fd must be specified <i>or</i> @ip and @port on a + * Either @fd must be specified <emphasis>or</emphasis> @ip and @port on a * file receive transfer. On send, @fd must be specified, and * @ip and @port are ignored. * @@ -745,8 +745,8 @@ * Displays a file transfer-related error message. * * This is a wrapper around purple_notify_error(), which automatically - * specifies a title ("File transfer to <i>user</i> failed" or - * "File Transfer from <i>user</i> failed"). + * specifies a title ("File transfer to <literal>user</literal> failed" or + * "File Transfer from <literal>user</literal> failed"). */ void purple_xfer_error(PurpleXferType type, PurpleAccount *account, const char *who, const char *msg);
--- a/libpurple/xmlnode.h Thu Feb 06 16:19:47 2014 +0530 +++ b/libpurple/xmlnode.h Thu Feb 06 16:46:43 2014 +0530 @@ -280,11 +280,11 @@ * own namespace. * * For example, given: - * \verbatim - * <iq type='get' xmlns='jabber:client' xmlns:ns1='http://example.org/ns1'> - * <ns1:element><child1/></ns1:element> - * </iq> - * \endverbatim + * <programlisting> + * <iq type='get' xmlns='jabber:client' xmlns:ns1='http://example.org/ns1'> + * <ns1:element><child1/></ns1:element> + * </iq> + * </programlisting> * * The default namespace of all nodes (including 'child1') is "jabber:client", * though the namespace for 'element' is "http://example.org/ns1".
