Mercurial > pidgin3 / changeset

--- a/libpurple/core.h	Sat Feb 01 17:27:24 2014 +0530
+++ b/libpurple/core.h	Sat Feb 01 21:45:12 2014 +0530
@@ -109,23 +109,21 @@
 /**
  * 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 @@
  * 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 @@
  * 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.

--- a/libpurple/request.h	Sat Feb 01 17:27:24 2014 +0530
+++ b/libpurple/request.h	Sat Feb 01 21:45:12 2014 +0530
@@ -1440,7 +1440,7 @@
  *
  * 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);

--- a/libpurple/util.h	Sat Feb 01 17:27:24 2014 +0530
+++ b/libpurple/util.h	Sat Feb 01 21:45:12 2014 +0530
@@ -556,11 +556,11 @@
  * purple_markup_escape_text:
  *
  * Escapes special characters in a plain-text string so they display
- * correctly as HTML.  For example, & is replaced with &amp; and < is
- * replaced with &lt;
+ * correctly as HTML.  For example, &amp; is replaced with &amp;amp; and &lt; is
+ * replaced with &amp;lt;
  *
  * This is exactly the same as g_markup_escape_text(), except that it
- * does not change ' to &apos; because &apos; is not a valid HTML 4 entity,
+ * does not change ' to &amp;apos; because &amp;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 @@
  * @text: The string in which to unescape any HTML entities
  *
  * Unescapes HTML entities to their literal characters in the text.
- * For example "&amp;" is replaced by '&' and so on.  Also converts
- * numerical entities (e.g. "&#38;" is also '&').
+ * For example "&amp;amp;" is replaced by '&amp;' and so on.  Also converts
+ * numerical entities (e.g. "&amp;\#38;" is also '&amp;').
  *
  * This function currently supports the following named entities:
- *     "&amp;", "&lt;", "&gt;", "&copy;", "&quot;", "&reg;", "&apos;"
+ *     "&amp;amp;", "&amp;lt;", "&amp;gt;", "&amp;copy;", "&amp;quot;",
+ *     "&amp;reg;", "&amp;apos;"
  *
- * purple_unescape_html() is similar, but also converts "<br>" into "\n".
+ * purple_unescape_html() is similar, but also converts "&lt;br&gt;" into "\n".
  *
  * Returns: The text with HTML entities literalized.  You must g_free
  *         this string when finished with it.
@@ -677,7 +678,7 @@
  * @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.
+ * "&lt;br&gt;" 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 @@
  * @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("&amp;")
- * will return "&". The @text variable is expected to point to an '&',
+ * entity pointed to by @text. For example, purple_markup_unescape_entity("&amp;amp;")
+ * will return "&amp;". The @text variable is expected to point to an '&amp;',
  * the first character of the entity. If given an unrecognized entity, the function
  * returns %NULL.
  *