mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-09-29 10:36:35 +02:00
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
This commit is contained in:
@@ -125,12 +125,14 @@ gchar* g_locale_from_utf8 (const gchar *utf8string,
|
|||||||
/* Convert between the operating system (or C runtime)
|
/* Convert between the operating system (or C runtime)
|
||||||
* representation of file names and UTF-8.
|
* representation of file names and UTF-8.
|
||||||
*/
|
*/
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_filename_to_utf8 g_filename_to_utf8_utf8
|
#define g_filename_to_utf8 g_filename_to_utf8_utf8
|
||||||
#define g_filename_from_utf8 g_filename_from_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_from_uri g_filename_from_uri_utf8
|
||||||
#define g_filename_to_uri g_filename_to_uri_utf8
|
#define g_filename_to_uri g_filename_to_uri_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
gchar* g_filename_to_utf8 (const gchar *opsysstring,
|
gchar* g_filename_to_utf8 (const gchar *opsysstring,
|
||||||
gssize len,
|
gssize len,
|
||||||
|
@@ -34,11 +34,13 @@ G_BEGIN_DECLS
|
|||||||
|
|
||||||
typedef struct _GDir GDir;
|
typedef struct _GDir GDir;
|
||||||
|
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
/* For DLL ABI stability, keep old names for old (non-UTF-8) functionality. */
|
/* For DLL ABI stability, keep old names for old (non-UTF-8) functionality. */
|
||||||
#define g_dir_open g_dir_open_utf8
|
#define g_dir_open g_dir_open_utf8
|
||||||
#define g_dir_read_name g_dir_read_name_utf8
|
#define g_dir_read_name g_dir_read_name_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
GDir * g_dir_open (const gchar *path,
|
GDir * g_dir_open (const gchar *path,
|
||||||
guint flags,
|
guint flags,
|
||||||
|
@@ -77,12 +77,14 @@ GQuark g_file_error_quark (void);
|
|||||||
/* So other code can generate a GFileError */
|
/* So other code can generate a GFileError */
|
||||||
GFileError g_file_error_from_errno (gint err_no);
|
GFileError g_file_error_from_errno (gint err_no);
|
||||||
|
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_file_test g_file_test_utf8
|
#define g_file_test g_file_test_utf8
|
||||||
#define g_file_get_contents g_file_get_contents_utf8
|
#define g_file_get_contents g_file_get_contents_utf8
|
||||||
#define g_mkstemp g_mkstemp_utf8
|
#define g_mkstemp g_mkstemp_utf8
|
||||||
#define g_file_open_tmp g_file_open_tmp_utf8
|
#define g_file_open_tmp g_file_open_tmp_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
gboolean g_file_test (const gchar *filename,
|
gboolean g_file_test (const gchar *filename,
|
||||||
GFileTest test);
|
GFileTest test);
|
||||||
|
@@ -75,6 +75,7 @@ typedef enum
|
|||||||
|
|
||||||
GQuark g_spawn_error_quark (void);
|
GQuark g_spawn_error_quark (void);
|
||||||
|
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_spawn_async g_spawn_async_utf8
|
#define g_spawn_async g_spawn_async_utf8
|
||||||
#define g_spawn_async_with_pipes g_spawn_async_with_pipes_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_sync g_spawn_command_line_sync_utf8
|
||||||
#define g_spawn_command_line_async g_spawn_command_line_async_utf8
|
#define g_spawn_command_line_async g_spawn_command_line_async_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
gboolean g_spawn_async (const gchar *working_directory,
|
gboolean g_spawn_async (const gchar *working_directory,
|
||||||
gchar **argv,
|
gchar **argv,
|
||||||
|
@@ -108,14 +108,14 @@ G_BEGIN_DECLS
|
|||||||
# define G_INLINE_FUNC
|
# define G_INLINE_FUNC
|
||||||
#endif /* !G_INLINE_FUNC */
|
#endif /* !G_INLINE_FUNC */
|
||||||
|
|
||||||
/* Retrive static string info
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
*/
|
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_get_user_name g_get_user_name_utf8
|
#define g_get_user_name g_get_user_name_utf8
|
||||||
#define g_get_real_name g_get_real_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_home_dir g_get_home_dir_utf8
|
||||||
#define g_get_tmp_dir g_get_tmp_dir_utf8
|
#define g_get_tmp_dir g_get_tmp_dir_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
G_CONST_RETURN gchar* g_get_user_name (void);
|
G_CONST_RETURN gchar* g_get_user_name (void);
|
||||||
G_CONST_RETURN gchar* g_get_real_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 */
|
#endif /* G_DISABLE_DEPRECATED */
|
||||||
|
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_get_current_dir g_get_current_dir_utf8
|
#define g_get_current_dir g_get_current_dir_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
/* The returned strings are newly allocated with g_malloc() */
|
/* The returned strings are newly allocated with g_malloc() */
|
||||||
gchar* g_get_current_dir (void);
|
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
|
/* return the environment string for the variable. The returned memory
|
||||||
* must not be freed. */
|
* must not be freed. */
|
||||||
|
#ifndef __GTK_DOC_IGNORE__
|
||||||
#ifdef G_OS_WIN32
|
#ifdef G_OS_WIN32
|
||||||
#define g_getenv g_getenv_utf8
|
#define g_getenv g_getenv_utf8
|
||||||
#define g_setenv g_setenv_utf8
|
#define g_setenv g_setenv_utf8
|
||||||
#define g_unsetenv g_unsetenv_utf8
|
#define g_unsetenv g_unsetenv_utf8
|
||||||
#define g_find_program_in_path g_find_program_in_path_utf8
|
#define g_find_program_in_path g_find_program_in_path_utf8
|
||||||
#endif
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
G_CONST_RETURN gchar* g_getenv (const gchar *variable);
|
G_CONST_RETURN gchar* g_getenv (const gchar *variable);
|
||||||
gboolean g_setenv (const gchar *variable,
|
gboolean g_setenv (const gchar *variable,
|
||||||
|
Reference in New Issue
Block a user