/soc/2013/ankitkv/gobjectification: d0aecd9a8104: Get rid of <tt>
Ankit Vani
a at nevitus.org
Sun Feb 2 07:44:19 EST 2014
Changeset: d0aecd9a81049cddd6506af550c2ddddbf9f0f8b
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 17:59 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/d0aecd9a8104
Description:
Get rid of <tt>
diffstat:
libpurple/account.h | 25 +++--
libpurple/accountopt.h | 4 +-
libpurple/cmds.h | 31 ++++---
libpurple/connection.h | 8 +-
libpurple/conversation.h | 2 +-
libpurple/eventloop.h | 6 +-
libpurple/log.h | 41 +++++----
libpurple/prefs.h | 6 +-
libpurple/prpl.h | 7 +-
libpurple/request.h | 199 ++++++++++++++++++++++++----------------------
pidgin/gtkutils.h | 4 +-
11 files changed, 175 insertions(+), 158 deletions(-)
diffs (truncated from 693 to 300 lines):
diff --git a/libpurple/account.h b/libpurple/account.h
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -452,12 +452,13 @@ void purple_account_set_status_types(Pur
/**
* @account: The account.
* @status_id: The ID of the status.
- * @active: Whether @a status_id is to be activated (<tt>TRUE</tt>) or
- * deactivated (<tt>FALSE</tt>).
- * @...: A NULL-terminated list of pairs of <tt>const char *</tt>
- * attribute name followed by <tt>const char *</tt> attribute value
- * for the status. (For example, one pair might be
- * <tt>"message"</tt> followed by <tt>"hello, talk to me!"</tt>.)
+ * @active: Whether @a status_id is to be activated (%TRUE) or
+ * deactivated (%FALSE).
+ * @...: 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
+ * <literal>"hello, talk to me!"</literal>.)
*
* Variadic version of purple_account_set_status_list().
*/
@@ -469,12 +470,12 @@ void purple_account_set_status(PurpleAcc
* purple_account_set_status_list:
* @account: The account.
* @status_id: The ID of the status.
- * @active: Whether @a status_id is to be activated (<tt>TRUE</tt>) or
- * deactivated (<tt>FALSE</tt>).
- * @attrs: A list of <tt>const char *</tt> attribute names followed by
- * <tt>const char *</tt> attribute values for the status.
- * (For example, one pair might be <tt>"message"</tt> followed
- * by <tt>"hello, talk to me!"</tt>.)
+ * @active: Whether @a status_id is to be activated (%TRUE) or
+ * deactivated (%FALSE).
+ * @attrs: A list of <type>const char *</type> attribute names followed by
+ * <type>const char *</type> attribute values for the status.
+ * (For example, one pair might be <literal>"message"</literal>
+ * followed by <literal>"hello, talk to me!"</literal>.)
*
* Activates or deactivates a status. All changes to the statuses of
* an account go through this function or purple_account_set_status().
diff --git a/libpurple/accountopt.h b/libpurple/accountopt.h
--- a/libpurple/accountopt.h
+++ b/libpurple/accountopt.h
@@ -126,7 +126,7 @@ PurpleAccountOption *purple_account_opti
* strings inside will be freed automatically.
*
* The list is a list of #PurpleKeyValuePair items. The key is the label that
- * should be displayed to the user, and the <tt>(const char *)</tt> value is
+ * should be displayed to the user, and the <type>(const char *)</type> value is
* the internal ID that should be passed to purple_account_set_string() to
* choose that value.
*
@@ -328,7 +328,7 @@ const GSList * purple_account_option_str
* Returns the list values for an account option.
*
* Returns: (transfer none): A list of #PurpleKeyValuePair, mapping the human-readable
- * description of the value to the <tt>(const char *)</tt> that
+ * description of the value to the <type>(const char *)</type> that
* should be passed to purple_account_set_string() to set the
* option.
*/
diff --git a/libpurple/cmds.h b/libpurple/cmds.h
--- a/libpurple/cmds.h
+++ b/libpurple/cmds.h
@@ -140,11 +140,14 @@ G_BEGIN_DECLS
* This string should contain no whitespace, and use a single
* character for each argument. The recognized characters are:
* <ul>
- * <li><tt>'w'</tt>: Matches a single word.</li>
- * <li><tt>'W'</tt>: Matches a single word, with formatting.</li>
- * <li><tt>'s'</tt>: Matches the rest of the arguments after this
- * point, as a single string.</li>
- * <li><tt>'S'</tt>: Same as <tt>'s'</tt> but with formatting.</li>
+ * <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
@@ -155,14 +158,14 @@ G_BEGIN_DECLS
* and usually the first command will stop any others from being
* called.
* @f: Flags specifying various options about this command, combined with
- * <tt>|</tt> (bitwise OR). You need to at least pass one of
+ * <literal>|</literal> (bitwise OR). You need to at least pass one of
* #PURPLE_CMD_FLAG_IM or #PURPLE_CMD_FLAG_CHAT (you may pass both) in
* order for the command to ever actually be called.
* @protocol_id: If the #PURPLE_CMD_FLAG_PRPL_ONLY flag is set, this is the id
* of the protocol to which the command applies (such as
- * <tt>"prpl-msn"</tt>). If the flag is not set, this parameter
- * is ignored; pass %NULL (or a humourous string of your
- * choice!).
+ * <literal>"prpl-msn"</literal>). If the flag is not set, this
+ * parameter is ignored; pass %NULL (or a humourous string of
+ * your choice!).
* @func: This is the function to call when someone enters this command.
* @helpstr: a whitespace sensitive, UTF-8, HTML string describing how to
* use the command. The preferred format of this string is the
@@ -225,14 +228,14 @@ PurpleCmdStatus purple_cmd_do_command(Pu
*
* List registered commands.
*
- * Returns a <tt>GList</tt> (which must be freed by the caller) of all commands
+ * Returns a #GList (which must be freed by the caller) of all commands
* that are valid in the context of @conv, or all commands, if @conv is
* %NULL. Don't keep this list around past the main loop, or anything else that
- * might unregister a command, as the <tt>const char *</tt>'s used get freed
+ * might unregister a command, as the <type>const char *</type>'s used get freed
* then.
*
- * Returns: A #GList of <tt>const char *</tt>, which must be freed with
- * <tt>g_list_free()</tt>.
+ * Returns: A #GList of <type>const char *</type>, which must be freed with
+ * g_list_free().
*/
GList *purple_cmd_list(PurpleConversation *conv);
@@ -247,7 +250,7 @@ GList *purple_cmd_list(PurpleConversatio
* Returns the help strings for a given command in the form of a GList,
* one node for each matching command.
*
- * Returns: A <tt>GList</tt> of <tt>const char *</tt>s, which is the help string
+ * Returns: A #GList of <type>const char *</type>s, which is the help string
* for that command.
*/
GList *purple_cmd_help(PurpleConversation *conv, const gchar *cmd);
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -507,13 +507,13 @@ purple_connection_ssl_error (PurpleConne
* should probably not be automatically reconnected) or transient (so
* auto-reconnection is a good idea).
* For instance, #PURPLE_CONNECTION_ERROR_NETWORK_ERROR is a temporary error,
- * which might be caused by losing the network connection, so <tt>
- * purple_connection_error_is_fatal (PURPLE_CONNECTION_ERROR_NETWORK_ERROR)</tt>
+ * which might be caused by losing the network connection, so <literal>
+ * purple_connection_error_is_fatal (PURPLE_CONNECTION_ERROR_NETWORK_ERROR)</literal>
* is %FALSE. On the other hand,
* #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED probably indicates a
* misconfiguration of the account which needs the user to go fix it up, so
- * <tt> purple_connection_error_is_fatal
- * (PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED)</tt> is %TRUE.
+ * <literal> purple_connection_error_is_fatal
+ * (PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED)</literal> is %TRUE.
*
* Returns: %TRUE if the account should not be automatically reconnected, and
* %FALSE otherwise.
diff --git a/libpurple/conversation.h b/libpurple/conversation.h
--- a/libpurple/conversation.h
+++ b/libpurple/conversation.h
@@ -259,7 +259,7 @@ struct _PurpleConversationUiOps
void (*chat_rename_user)(PurpleChatConversation *chat, const char *old_name,
const char *new_name, const char *new_alias);
/** Remove @users from a chat.
- * @users: A GList of <tt>const char *</tt>s.
+ * @users: A GList of <type>const char *</type>s.
* @see purple_chat_conversation_rename_user()
*/
void (*chat_remove_users)(PurpleChatConversation *chat, GList *users);
diff --git a/libpurple/eventloop.h b/libpurple/eventloop.h
--- a/libpurple/eventloop.h
+++ b/libpurple/eventloop.h
@@ -60,7 +60,7 @@ typedef struct _PurpleEventLoopUiOps Pur
* An abstraction of an application's mainloop; libpurple will use this to
* watch file descriptors and schedule timed callbacks. If your application
* uses the glib mainloop, there is an implementation of this struct in
- * <tt>libpurple/example/nullclient.c</tt> which you can use verbatim.
+ * <filename>libpurple/example/nullclient.c</filename> which you can use verbatim.
*/
struct _PurpleEventLoopUiOps
{
@@ -131,8 +131,8 @@ struct _PurpleEventLoopUiOps
*
* Implementation of this UI op is optional. Implement it if the UI's
* sockets or event loop needs to customize determination of socket
- * error status. If unimplemented, <tt>getsockopt(2)</tt> will be used
- * instead.
+ * error status. If unimplemented, <literal>getsockopt(2)</literal> will
+ * be used instead.
*
* @see purple_input_get_error
*/
diff --git a/libpurple/log.h b/libpurple/log.h
--- a/libpurple/log.h
+++ b/libpurple/log.h
@@ -429,7 +429,7 @@ void purple_log_set_free(PurpleLogSet *s
* file handle and log path.
*
* This function is intended to be used as a "common"
- * implementation of a logger's <tt>write</tt> function.
+ * implementation of a logger's <literal>write</literal> function.
* It should only be passed to purple_log_logger_new() and never
* called directly.
*/
@@ -447,7 +447,7 @@ void purple_log_common_writer(PurpleLog
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
- * a "common" implementation of a logger's <tt>list</tt> function.
+ * a "common" implementation of a logger's <literal>list</literal> function.
* It should only be passed to purple_log_logger_new() and never
* called directly.
*
@@ -470,8 +470,8 @@ GList *purple_log_common_lister(PurpleLo
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
- * a "common" implementation of a logger's <tt>total_size</tt> function.
- * It should only be passed to purple_log_logger_new() and never
+ * a "common" implementation of a logger's <literal>total_size</literal>
+ * function. It should only be passed to purple_log_logger_new() and never
* called directly.
*
* Returns: The size of all the logs with the specified extension
@@ -488,7 +488,7 @@ int purple_log_common_total_sizer(Purple
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
- * a "common" implementation of a logger's <tt>size</tt> function.
+ * a "common" implementation of a logger's <literal>size</literal> function.
* It should only be passed to purple_log_logger_new() and never
* called directly.
*
@@ -504,7 +504,7 @@ int purple_log_common_sizer(PurpleLog *l
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
- * a "common" implementation of a logger's <tt>delete</tt> function.
+ * a "common" implementation of a logger's <literal>delete</literal> function.
* It should only be passed to purple_log_logger_new() and never
* called directly.
*
@@ -520,8 +520,8 @@ gboolean purple_log_common_deleter(Purpl
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
- * a "common" implementation of a logger's <tt>is_deletable</tt> function.
- * It should only be passed to purple_log_logger_new() and never
+ * a "common" implementation of a logger's <literal>is_deletable</literal>
+ * function. It should only be passed to purple_log_logger_new() and never
* called directly.
*
* Returns: A boolean indicating if the log is deletable.
@@ -540,19 +540,22 @@ gboolean purple_log_common_is_deletable(
* @id: The logger's id.
* @name: The logger's name.
* @functions: The number of functions being passed. The following
- * functions are currently available (in order): <tt>create</tt>,
- * <tt>write</tt>, <tt>finalize</tt>, <tt>list</tt>,
- * <tt>read</tt>, <tt>size</tt>, <tt>total_size</tt>,
- * <tt>list_syslog</tt>, <tt>get_log_sets</tt>, <tt>remove</tt>,
- * <tt>is_deletable</tt>.
+ * functions are currently available (in order):
+ * <literal>create</literal>, <literal>write</literal>,
+ * <literal>finalize</literal>, <literal>list</literal>,
+ * <literal>read</literal>, <literal>size</literal>,
+ * <literal>total_size</literal>, <literal>list_syslog</literal>,
+ * <literal>get_log_sets</literal>, <literal>remove</literal>,
+ * <literal>is_deletable</literal>.
* For details on these functions, see PurpleLogLogger.
* Functions may not be skipped. For example, passing
- * <tt>create</tt> and <tt>write</tt> is acceptable (for a total
- * of two functions). Passing <tt>create</tt> and
- * <tt>finalize</tt>, however, is not. To accomplish that, the
- * caller must pass <tt>create</tt>, %NULL (a placeholder for
- * <tt>write</tt>), and <tt>finalize</tt> (for a total of 3
- * functions).
+ * <literal>create</literal> and <literal>write</literal> is
+ * acceptable (for a total of two functions). Passing
+ * <literal>create</literal> and <literal>finalize</literal>,
+ * however, is not. To accomplish that, the caller must pass
+ * <literal>create</literal>, %NULL (a placeholder for
+ * <literal>write</literal>), and <literal>finalize</literal>
+ * (for a total of 3 functions).
*
* Creates a new logger
*
diff --git a/libpurple/prefs.h b/libpurple/prefs.h
--- a/libpurple/prefs.h
+++ b/libpurple/prefs.h
@@ -59,9 +59,9 @@ typedef enum
* @type: the type of the preferenced named @name
* @val: the new value of the preferencs; should be cast to the correct
* type. For instance, to recover the value of a #PURPLE_PREF_INT
- * preference, use <tt>GPOINTER_TO_INT(val)</tt>. Alternatively,
- * just call purple_prefs_get_int(), purple_prefs_get_string_list()
- * etc.
+ * preference, use <literal>GPOINTER_TO_INT(val)</literal>.
+ * Alternatively, just call purple_prefs_get_int(),
+ * purple_prefs_get_string_list() etc.
* @data: Arbitrary data specified when the callback was connected with
* purple_prefs_connect_callback().
*
More information about the Commits
mailing list