Require gtk-doc 1.8.

2007-11-25  Matthias Clasen  <mclasen@redhat.com>

        * configure.in: Require gtk-doc 1.8.

        * glib/gasyncqueue.c:
        * glib/gdate.c:
        * glib/gfileutils.c:
        * glib/gmain.c:
        * glib/gmarkup.c:
        * glib/gregex.c:
        * glib/gtestutils.c:
        * glib/gutils.c: Use gtk-doc abbreviations for
        examples in doc comments.

svn path=/trunk/; revision=5933

diff --git a/ChangeLog b/ChangeLog
index 5746d04..b4e0abc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2007-11-25  Matthias Clasen  <mclasen@redhat.com>
+
+       * configure.in: Require gtk-doc 1.8.
+
+       * glib/gasyncqueue.c:
+       * glib/gdate.c:
+       * glib/gfileutils.c:
+       * glib/gmain.c:
+       * glib/gmarkup.c:
+       * glib/gregex.c:
+       * glib/gtestutils.c:
+       * glib/gutils.c: Use gtk-doc abbreviations for 
+       examples in doc comments.
+
 2007-11-24  Matthias Clasen  <mclasen@redhat.com>
 
        * */Makefile.am: Replace INCLUDES by AM_CPPFLAGS, other

diff --git a/configure.in b/configure.in
index adc3ab5..86512d6 100644 (file)
--- a/configure.in
+++ b/configure.in
@@ -2299,7 +2299,7 @@ dnl **************************
 dnl *** Checks for gtk-doc ***
 dnl **************************
 
-GTK_DOC_CHECK([1.4])
+GTK_DOC_CHECK([1.8])
 
 AC_ARG_ENABLE(man,
               [AC_HELP_STRING([--enable-man],

diff --git a/glib/gasyncqueue.c b/glib/gasyncqueue.c
index 646efd2..dbaebde 100644 (file)
--- a/glib/gasyncqueue.c
+++ b/glib/gasyncqueue.c
@@ -565,7 +565,7 @@ g_async_queue_length_unlocked (GAsyncQueue* queue)
  *
  * If you were sorting a list of priority numbers to make sure the
  * lowest priority would be at the top of the queue, you could use:
- * <informalexample><programlisting> 
+ * |[
  *  gint32 id1;
  *  gint32 id2;
  *   
@@ -573,7 +573,7 @@ g_async_queue_length_unlocked (GAsyncQueue* queue)
  *  id2 = GPOINTER_TO_INT (element2);
  *   
  *  return (id1 > id2 ? +1 : id1 == id2 ? 0 : -1);
- * </programlisting></informalexample>
+ * ]|
  *
  * Since: 2.10
  **/

diff --git a/glib/gdate.c b/glib/gdate.c
index 2224fe3..2b4bebf 100644 (file)
--- a/glib/gdate.c
+++ b/glib/gdate.c
@@ -864,9 +864,9 @@ g_date_set_parse (GDate       *d,
  * Sets the value of a date from a <type>time_t</type> value. 
  *
  * To set the value of a date to the current day, you could write:
- * <informalexample><programlisting> 
+ * |[
  *  g_date_set_time_t (date, time (NULL)); 
- * </programlisting></informalexample>
+ * ]|
  *
  * Since: 2.10
  */

diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 040ed7b..5025b3a 100644 (file)
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -154,14 +154,14 @@ g_mkdir_with_parents (const gchar *pathname,
  * For example, you might think you could use %G_FILE_TEST_IS_SYMLINK
  * to know whether it is is safe to write to a file without being
  * tricked into writing into a different location. It doesn't work!
- *
- * <informalexample><programlisting>
+ * |[
  * /&ast; DON'T DO THIS &ast;/
- *  if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK)) {
- *    fd = g_open (filename, O_WRONLY);
- *    /&ast; write to fd &ast;/
- *  }
- * </programlisting></informalexample>
+ *  if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK)) 
+ *    {
+ *      fd = g_open (filename, O_WRONLY);
+ *      /&ast; write to fd &ast;/
+ *    }
+ * ]|
  *
  * Another thing to note is that %G_FILE_TEST_EXISTS and
  * %G_FILE_TEST_IS_EXECUTABLE are implemented using the access()

diff --git a/glib/gmain.c b/glib/gmain.c
index 52b1c21..74a3c80 100644 (file)
--- a/glib/gmain.c
+++ b/glib/gmain.c
@@ -1897,7 +1897,7 @@ g_main_current_source (void)
  * from within idle handlers, but may have freed the object 
  * before the dispatch of your idle handler.
  *
- * <informalexample><programlisting>
+ * |[
  * static gboolean 
  * idle_callback (gpointer data)
  * {
@@ -1927,7 +1927,7 @@ g_main_current_source (void)
  *    
  *   G_OBJECT_CLASS (parent_class)->finalize (object);
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * This will fail in a multi-threaded application if the 
  * widget is destroyed before the idle handler fires due 
@@ -1935,7 +1935,7 @@ g_main_current_source (void)
  * this particular problem, is to check to if the source
  * has already been destroy within the callback.
  *
- * <informalexample><programlisting>
+ * |[
  * static gboolean 
  * idle_callback (gpointer data)
  * {
@@ -1950,7 +1950,7 @@ g_main_current_source (void)
  *   
  *   return FALSE;
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: %TRUE if the source has been destroyed
  *

diff --git a/glib/gmarkup.c b/glib/gmarkup.c
index ca6c445..2399c70 100644 (file)
--- a/glib/gmarkup.c
+++ b/glib/gmarkup.c
@@ -2296,7 +2296,7 @@ g_markup_vprintf_escaped (const char *format,
  * output, without having to worry that the strings
  * might themselves contain markup.
  *
- * <informalexample><programlisting>
+ * |[
  * const char *store = "Fortnum &amp; Mason";
  * const char *item = "Tea";
  * char *output;
@@ -2306,7 +2306,7 @@ g_markup_vprintf_escaped (const char *format,
  *                                   "&lt;item&gt;&percnt;s&lt;/item&gt;"
  *                                   "&lt;/purchase&gt;",
  *                                   store, item);
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: newly allocated result from formatting
  *  operation. Free with g_free().

diff --git a/glib/gregex.c b/glib/gregex.c
index b5bc6a1..227fcfd 100644 (file)
--- a/glib/gregex.c
+++ b/glib/gregex.c
@@ -1103,7 +1103,7 @@ g_regex_match_simple (const gchar        *pattern,
  * To retrieve all the non-overlapping matches of the pattern in 
  * string you can use g_match_info_next().
  *
- * <informalexample><programlisting>
+ * |[
  * static void
  * print_uppercase_words (const gchar *string)
  * {
@@ -1123,7 +1123,7 @@ g_regex_match_simple (const gchar        *pattern,
  *   g_match_info_free (match_info);
  *   g_regex_unref (regex);
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Returns: %TRUE is the string matched, %FALSE otherwise
  *
@@ -1172,7 +1172,7 @@ g_regex_match (const GRegex      *regex,
  * To retrieve all the non-overlapping matches of the pattern in 
  * string you can use g_match_info_next().
  *
- * <informalexample><programlisting>
+ * |[
  * static void
  * print_uppercase_words (const gchar *string)
  * {
@@ -1198,7 +1198,7 @@ g_regex_match (const GRegex      *regex,
  *       g_error_free (error);
  *     }
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Returns: %TRUE is the string matched, %FALSE otherwise
  *

diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index 8335a58..4543017 100644 (file)
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -1275,7 +1275,7 @@ test_time_stamp (void)
  * The forking parent process then asserts successfull child program
  * termination and validates cihld program outputs.
  *
- * <informalexample><programlisting>
+ * |[
  *   static void
  *   test_fork_patterns (void)
  *   {
@@ -1289,7 +1289,7 @@ test_time_stamp (void)
  *     g_test_trap_assert_stdout ("*somagic17*");
  *     g_test_trap_assert_stderr ("*semagic43*");
  *   }
- * </programlisting></informalexample>
+ * ]|
  *
  * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
  */

diff --git a/glib/gutils.c b/glib/gutils.c
index 1e3b4fb..dd9d0e1 100644 (file)
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -36,6 +36,7 @@
 #include <stdarg.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <libintl.h>
 #include <locale.h>
 #include <string.h>
 #include <ctype.h>             /* For tolower() */
@@ -1781,11 +1782,11 @@ g_get_real_name (void)
  * g_get_homedir() not pay attention to <envar>HOME</envar> and to 
  * return the real home directory for the user. If applications
  * want to pay attention to <envar>HOME</envar>, they can do:
- * <informalexample><programlisting>
+ * |[
  *  const char *homedir = g_getenv ("HOME");
  *   if (!homedir)
  *      homedir = g_get_homedir (<!-- -->);
- * </programlisting></informalexample>
+ * ]|
  *
  * Returns: the current user's home directory
  */
@@ -3130,10 +3131,6 @@ _g_utils_thread_init (void)
   g_get_language_names ();
 }
 
-#ifdef ENABLE_NLS
-
-#include <libintl.h>
-
 #ifdef G_OS_WIN32
 
 /**
@@ -3182,11 +3179,11 @@ _glib_gettext (const gchar *str)
   if (!_glib_gettext_initialized)
     {
 #ifdef G_OS_WIN32
-      gchar *tmp = _glib_get_locale_dir();
-      bindtextdomain(GETTEXT_PACKAGE, tmp);
-      g_free(tmp);
+      gchar *tmp = _glib_get_locale_dir ();
+      bindtextdomain (GETTEXT_PACKAGE, tmp);
+      g_free (tmp);
 #else
-      bindtextdomain(GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
+      bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
 #endif
 #    ifdef HAVE_BIND_TEXTDOMAIN_CODESET
       bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
@@ -3197,8 +3194,6 @@ _glib_gettext (const gchar *str)
   return dgettext (GETTEXT_PACKAGE, str);
 }
 
-#endif /* ENABLE_NLS */
-
 #ifdef G_OS_WIN32
 
 /* Binary compatibility versions. Not for newly compiled code. */