Docs: Drop entities, switch away from sgml mode

Since all element markup is now gone from the doc comments,
we can turn off the gtk-doc sgml mode, which means that from
now on, docbook markup is no longer allowed in doc comments.

To make this possible, we have to replace all remaining
entities in doc comments by their replacement text, & -> &
and so on.
This commit is contained in:
Matthias Clasen
2014-02-09 02:07:26 -05:00
parent a03cee3b27
commit 35066ed6c6
39 changed files with 104 additions and 103 deletions

View File

@@ -393,7 +393,7 @@
* g_assert_cmpstr:
* @s1: a string (may be %NULL)
* @cmp: The comparison operator to use.
* One of ==, !=, <, >, <=, >=.
* One of ==, !=, <, >, <=, >=.
* @s2: another string (may be %NULL)
*
* Debugging macro to compare two strings. If the comparison fails,
@@ -417,7 +417,7 @@
* g_assert_cmpint:
* @n1: an integer
* @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=.
* One of ==, !=, <, >, <=, >=.
* @n2: another integer
*
* Debugging macro to compare two integers.
@@ -434,7 +434,7 @@
* g_assert_cmpuint:
* @n1: an unsigned integer
* @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=.
* One of ==, !=, <, >, <=, >=.
* @n2: another unsigned integer
*
* Debugging macro to compare two unsigned integers.
@@ -451,7 +451,7 @@
* g_assert_cmphex:
* @n1: an unsigned integer
* @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=.
* One of ==, !=, <, >, <=, >=.
* @n2: another unsigned integer
*
* Debugging macro to compare to unsigned integers.
@@ -466,7 +466,7 @@
* g_assert_cmpfloat:
* @n1: an floating point number
* @cmp: The comparison operator to use.
* One of ==, !=, &lt;, &gt;, &lt;=, &gt;=.
* One of ==, !=, <, >, <=, >=.
* @n2: another floating point number
*
* Debugging macro to compare two floating point numbers.
@@ -503,8 +503,8 @@
* the correct #GError.
*
* The effect of `g_assert_error (err, dom, c)` is
* the same as `g_assert_true (err != NULL &amp;&amp; err->domain
* == dom &amp;&amp; err->code == c)`. The advantage of this
* the same as `g_assert_true (err != NULL && err->domain
* == dom && err->code == c)`. The advantage of this
* macro is that it can produce a message that includes the incorrect
* error message and code.
*