Some doc cleanups

svn path=/trunk/; revision=5985

diff --git a/ChangeLog b/ChangeLog
index 4b38bec..c615eff 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2007-11-28  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gurifuncs.c: Some doc cleanups
+
+2007-11-28  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gtestutils.c: Fix up some doc comments, avoid C99 comments
+
+       * glib/gconvert.c: De-doc-commentify static functions to
+       shut up gtk-doc.
+
+       * glib/gutils.c: Fix the glib_gettext doc comment.
+
 2007-11-28  Tor Lillqvist  <tml@novell.com>
 
        * config.h.win32.in: Update to match what configure produces.

diff --git a/glib/gurifuncs.c b/glib/gurifuncs.c
index 731dc6d..8b728c0 100644 (file)
--- a/glib/gurifuncs.c
+++ b/glib/gurifuncs.c
@@ -34,7 +34,6 @@
  * defined by RFC 3986. It is highly recommended that you have read and
  * understand RFC 3986 for understanding this API. A copy of RFC 3986 
  * can be found at <ulink url="http://www.ietf.org/rfc/rfc3986.txt"/>.
- *
  **/
 
 static int
@@ -145,7 +144,9 @@ g_uri_unescape_string (const char *escaped_string,
  * @uri: a valid URI.
  * 
  * Gets the scheme portion of a URI. RFC 3986 decodes the scheme as:
+ * <programlisting>
  * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] 
+ * </programlisting>
  * Common schemes include "file", "http", "svn+ssh", etc.
  * 
  * Returns: The "Scheme" component of the URI, or %NULL on error. 
@@ -194,8 +195,9 @@ g_uri_get_scheme (const char  *uri)
 /**
  * g_uri_escape_string:
  * @unescaped: the unescaped input string.
- * @reserved_chars_allowed: a string of reserve characters allowed to be used.
- * @allow_utf8: a #gboolean. Set to %TRUE if string can include UTF8 characters.
+ * @reserved_chars_allowed: a string of reserved characters that are
+ *      allowed to be used.
+ * @allow_utf8: %TRUE if the result can include UTF-8 characters.
  * 
  * Escapes a string for use in a URI.
  *