/soc/2013/ankitkv/gobjectification: 8f134af3e36d: Fix gtk-doc er...

Ankit Vani a at nevitus.org
Sat Feb 1 12:09:58 EST 2014 

Changeset: 8f134af3e36d1c40822ed869c89a429b10b5719f
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-01 21:44 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/8f134af3e36d

Description:

Fix gtk-doc errors

diffstat:

 libpurple/core.h    |  54 +++++++++++++++++++++++++++++-----------------------
 libpurple/request.h |   2 +-
 libpurple/util.h    |  21 ++++++++++---------
 3 files changed, 42 insertions(+), 35 deletions(-)

diffs (160 lines):

diff --git a/libpurple/core.h b/libpurple/core.h
--- a/libpurple/core.h
+++ b/libpurple/core.h
@@ -109,23 +109,21 @@ void purple_core_quit(void);
 /**
  * purple_core_quit_cb:
  *
- * <p>
  * Calls purple_core_quit().  This can be used as the function
  * passed to purple_timeout_add() when you want to shutdown Purple
  * in a specified amount of time.  When shutting down Purple
  * from a plugin, you must use this instead of purple_core_quit();
  * for an immediate exit, use a timeout value of 0:
- * </p>
  *
- * <code>purple_timeout_add(0, purple_core_quitcb, NULL);</code>
+ * <programlisting>
+ * purple_timeout_add(0, purple_core_quitcb, NULL)
+ * </programlisting>
  *
- * <p>
  * This is ensures that code from your plugin is not being
  * executed when purple_core_quit() is called.  If the plugin
  * called purple_core_quit() directly, you would get a core dump
  * after purple_core_quit() executes and control returns to your
  * plugin because purple_core_quit() frees all plugins.
- * </p>
  */
 gboolean purple_core_quit_cb(gpointer unused);
 
@@ -183,7 +181,7 @@ PurpleCoreUiOps *purple_core_get_ui_ops(
  * process.
  *
  * Returns: %TRUE if this is the first instance of libpurple running;
- *         %FALSE if there is another instance running.
+ *          %FALSE if there is another instance running.
  */
 gboolean purple_core_ensure_single_instance(void);
 
@@ -194,25 +192,33 @@ gboolean purple_core_ensure_single_insta
  * following well-known entries may be in the table (along with any others the
  * UI might choose to include):
  *
- * <dl>
- *   <dt><tt>name</tt></dt>
- *   <dd>the user-readable name for the UI.</dd>
- *
- *   <dt><tt>version</tt></dt>
- *   <dd>a user-readable description of the current version of the UI.</dd>
- *
- *   <dt><tt>website</tt></dt>
- *   <dd>the UI's website, such as https://pidgin.im.</dd>
- *
- *   <dt><tt>dev_website</tt></dt>
- *   <dd>the UI's development/support website, such as https://developer.pidgin.im.</dd>
- *
- *   <dt><tt>client_type</tt></dt>
- *   <dd>the type of UI. Possible values include 'pc', 'console', 'phone',
+ * <informaltable frame='none'>
+ *   <tgroup cols='2'><tbody>
+ *   <row>
+ *     <entry><tt>name</tt></entry>
+ *     <entry>the user-readable name for the UI.</entry>
+ *   </row>
+ *   <row>
+ *     <entry><tt>version</tt></entry>
+ *     <entry>a user-readable description of the current version of the UI.</entry>
+ *   </row>
+ *   <row>
+ *     <entry><tt>website</tt></entry>
+ *     <entry>the UI's website, such as https://pidgin.im.</entry>
+ *   </row>
+ *   <row>
+ *     <entry><tt>dev_website</tt></entry>
+ *     <entry>the UI's development/support website, such as
+ *       https://developer.pidgin.im.</entry>
+ *   </row>
+ *   <row>
+ *     <entry><tt>client_type</tt></entry>
+ *     <entry>the type of UI. Possible values include 'pc', 'console', 'phone',
  *       'handheld', 'web', and 'bot'. These values are compared
- *       programmatically and should not be localized.</dd>
- *
- * </dl>
+ *       programmatically and should not be localized.</entry>
+ *   </row>
+ *   </tbody></tgroup>
+ * </informaltable>
  *
  * Returns: A GHashTable with strings for keys and values.  This
  * hash table must not be freed and should not be modified.
diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -1440,7 +1440,7 @@ purple_request_field_choice_get_value(co
  *
  * Returns a list of elements in a choice field.
  *
- * Returns: (transfer none): The list of pairs <label, value>.
+ * Returns: (transfer none): The list of pairs of {label, value}.
  */
 GList *
 purple_request_field_choice_get_elements(const PurpleRequestField *field);
diff --git a/libpurple/util.h b/libpurple/util.h
--- a/libpurple/util.h
+++ b/libpurple/util.h
@@ -556,11 +556,11 @@ char *purple_uts35_to_str(const char *fo
  * purple_markup_escape_text:
  *
  * Escapes special characters in a plain-text string so they display
- * correctly as HTML.  For example, & is replaced with & and < is
- * replaced with <
+ * correctly as HTML.  For example, & is replaced with &amp; and < is
+ * replaced with &lt;
  *
  * This is exactly the same as g_markup_escape_text(), except that it
- * does not change ' to ' because ' is not a valid HTML 4 entity,
+ * does not change ' to &apos; because &apos; is not a valid HTML 4 entity,
  * and is displayed literally in IE7.
  */
 gchar *purple_markup_escape_text(const gchar *text, gssize length);
@@ -657,13 +657,14 @@ char *purple_markup_linkify(const char *
  * @text: The string in which to unescape any HTML entities
  *
  * Unescapes HTML entities to their literal characters in the text.
- * For example "&" is replaced by '&' and so on.  Also converts
- * numerical entities (e.g. "&" is also '&').
+ * For example "&amp;" is replaced by '&' and so on.  Also converts
+ * numerical entities (e.g. "&\#38;" is also '&').
  *
  * This function currently supports the following named entities:
- *     "&", "<", ">", "©", """, "®", "'"
+ *     "&amp;", "&lt;", "&gt;", "&copy;", "&quot;",
+ *     "&reg;", "&apos;"
  *
- * purple_unescape_html() is similar, but also converts "<br>" into "\n".
+ * purple_unescape_html() is similar, but also converts "<br>" into "\n".
  *
  * Returns: The text with HTML entities literalized.  You must g_free
  *         this string when finished with it.
@@ -677,7 +678,7 @@ char *purple_unescape_text(const char *t
  * @html: The string in which to unescape any HTML entities
  *
  * Unescapes HTML entities to their literal characters and converts
- * "<br>" to "\n".  See purple_unescape_text() for more details.
+ * "<br>" to "\n".  See purple_unescape_text() for more details.
  *
  * Returns: The text with HTML entities literalized.  You must g_free
  *         this string when finished with it.
@@ -729,8 +730,8 @@ char *purple_markup_get_tag_name(const c
  * @length: If not %NULL, the string length of the entity is stored in this location.
  *
  * Returns a constant string of the character representation of the HTML
- * entity pointed to by @text. For example, purple_markup_unescape_entity("&")
- * will return "&". The @text variable is expected to point to an '&',
+ * entity pointed to by @text. For example, purple_markup_unescape_entity("&amp;")
+ * will return "&". The @text variable is expected to point to an '&',
  * the first character of the entity. If given an unrecognized entity, the function
  * returns %NULL.
  *

More information about the Commits mailing list