Fix parameter documentation for many functions

Use the opt-out mechanism introduced in gtk-doc 1.16 to work
around problems with the _utf8 renaming games that the win32
port is playing in our headers.

https://bugzilla.gnome.org/show_bug.cgi?id=638449

diff --git a/glib/gconvert.h b/glib/gconvert.h
index e4c20d7..3650b99 100644 (file)
--- a/glib/gconvert.h
+++ b/glib/gconvert.h
@@ -125,12 +125,14 @@ gchar* g_locale_from_utf8 (const gchar  *utf8string,
 /* Convert between the operating system (or C runtime)
  * representation of file names and UTF-8.
  */
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_filename_to_utf8 g_filename_to_utf8_utf8
 #define g_filename_from_utf8 g_filename_from_utf8_utf8
 #define g_filename_from_uri g_filename_from_uri_utf8
 #define g_filename_to_uri g_filename_to_uri_utf8 
 #endif
+#endif
 
 gchar* g_filename_to_utf8   (const gchar  *opsysstring,
                             gssize        len,            

diff --git a/glib/gdir.h b/glib/gdir.h
index 85e9896..a8085c9 100644 (file)
--- a/glib/gdir.h
+++ b/glib/gdir.h
@@ -34,11 +34,13 @@ G_BEGIN_DECLS
 
 typedef struct _GDir GDir;
 
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 /* For DLL ABI stability, keep old names for old (non-UTF-8) functionality. */
 #define g_dir_open g_dir_open_utf8
 #define g_dir_read_name g_dir_read_name_utf8
 #endif
+#endif
 
 GDir    *                g_dir_open           (const gchar  *path,
                                               guint         flags,

diff --git a/glib/gfileutils.h b/glib/gfileutils.h
index d8f9d3b..a3c7029 100644 (file)
--- a/glib/gfileutils.h
+++ b/glib/gfileutils.h
@@ -77,12 +77,14 @@ GQuark     g_file_error_quark      (void);
 /* So other code can generate a GFileError */
 GFileError g_file_error_from_errno (gint err_no);
 
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_file_test g_file_test_utf8
 #define g_file_get_contents g_file_get_contents_utf8
 #define g_mkstemp g_mkstemp_utf8
 #define g_file_open_tmp g_file_open_tmp_utf8
 #endif
+#endif
 
 gboolean g_file_test         (const gchar  *filename,
                               GFileTest     test);

diff --git a/glib/gspawn.h b/glib/gspawn.h
index 9836b34..fa8bfab 100644 (file)
--- a/glib/gspawn.h
+++ b/glib/gspawn.h
@@ -75,6 +75,7 @@ typedef enum
 
 GQuark g_spawn_error_quark (void);
 
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_spawn_async g_spawn_async_utf8
 #define g_spawn_async_with_pipes g_spawn_async_with_pipes_utf8
@@ -82,6 +83,7 @@ GQuark g_spawn_error_quark (void);
 #define g_spawn_command_line_sync g_spawn_command_line_sync_utf8
 #define g_spawn_command_line_async g_spawn_command_line_async_utf8
 #endif
+#endif
 
 gboolean g_spawn_async (const gchar           *working_directory,
                         gchar                **argv,

diff --git a/glib/gutils.h b/glib/gutils.h
index 6b94efd..cfb745f 100644 (file)
--- a/glib/gutils.h
+++ b/glib/gutils.h
@@ -108,14 +108,14 @@ G_BEGIN_DECLS
 #  define G_INLINE_FUNC
 #endif /* !G_INLINE_FUNC */
 
-/* Retrive static string info
- */
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_get_user_name g_get_user_name_utf8
 #define g_get_real_name g_get_real_name_utf8
 #define g_get_home_dir g_get_home_dir_utf8
 #define g_get_tmp_dir g_get_tmp_dir_utf8
 #endif
+#endif
 
 G_CONST_RETURN gchar* g_get_user_name        (void);
 G_CONST_RETURN gchar* g_get_real_name        (void);
@@ -235,9 +235,11 @@ G_CONST_RETURN gchar* g_basename           (const gchar *file_name);
 
 #endif /* G_DISABLE_DEPRECATED */
 
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_get_current_dir g_get_current_dir_utf8
 #endif
+#endif
 
 /* The returned strings are newly allocated with g_malloc() */
 gchar*                g_get_current_dir    (void);
@@ -249,12 +251,14 @@ void                  g_nullify_pointer    (gpointer    *nullify_location);
 
 /* return the environment string for the variable. The returned memory
  * must not be freed. */
+#ifndef __GTK_DOC_IGNORE__
 #ifdef G_OS_WIN32
 #define g_getenv g_getenv_utf8
 #define g_setenv g_setenv_utf8
 #define g_unsetenv g_unsetenv_utf8
 #define g_find_program_in_path g_find_program_in_path_utf8
 #endif
+#endif
 
 G_CONST_RETURN gchar* g_getenv             (const gchar *variable);
 gboolean              g_setenv             (const gchar *variable,