From 1a2a689deacaac32b351ae97b00d8c35a6499cf6 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Sat, 29 Nov 2014 08:39:24 -0500 Subject: [PATCH] Doc: glib: Fix all undocumented/unused/undeclared symbols There is one issue left in gscanner.h due to a bug #741305 in gtk-doc. https://bugzilla.gnome.org/show_bug.cgi?id=740814 --- docs/reference/glib/Makefile.am | 6 +++- docs/reference/glib/glib-overrides.txt | 5 ---- docs/reference/glib/glib-sections.txt | 50 ++++++++++++++++++++++++++++++++++ glib/docs.c | 14 ++++++++-- glib/gconstructor.h | 3 ++ glib/gconvert.h | 2 ++ glib/gdir.h | 2 ++ glib/genviron.h | 3 +- glib/gfileutils.h | 2 ++ glib/ghash.c | 2 ++ glib/giochannel.h | 2 ++ glib/gkeyfile.c | 20 +++++++++++++- glib/goption.c | 3 ++ glib/gspawn.h | 2 ++ glib/gstdio.c | 2 ++ glib/gunicode.h | 4 +-- glib/gwin32.h | 2 ++ glib/valgrind.h | 2 -- 18 files changed, 112 insertions(+), 14 deletions(-) diff --git a/docs/reference/glib/Makefile.am b/docs/reference/glib/Makefile.am index a25a7c8..67de7fe 100644 --- a/docs/reference/glib/Makefile.am +++ b/docs/reference/glib/Makefile.am @@ -50,7 +50,11 @@ IGNORE_HFILES = \ gvariant-serialiser.h \ gvariant-core.h \ gvarianttypeinfo.h \ - gwakeup.h + gwakeup.h \ + gtranslit-data.h \ + glib-init.h \ + gconstructor.h \ + valgrind.h # Images to copy into HTML directory HTML_IMAGES = \ diff --git a/docs/reference/glib/glib-overrides.txt b/docs/reference/glib/glib-overrides.txt index c8ae3d5..b2774c0 100644 --- a/docs/reference/glib/glib-overrides.txt +++ b/docs/reference/glib/glib-overrides.txt @@ -206,11 +206,6 @@ GCond *cond #define G_OS_WIN32 - -G_OS_BEOS -#define G_OS_BEOS - - # g_ascii_isxxx diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 20b7101..d34600f 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -75,6 +75,7 @@ G_GSIZE_FORMAT gssize G_MINSSIZE G_MAXSSIZE +G_GSSIZE_MODIFIER G_GSSIZE_FORMAT goffset G_MINOFFSET @@ -91,6 +92,7 @@ guintptr G_GUINTPTR_FORMAT +GLIB_SIZEOF_SSIZE_T GLIB_SIZEOF_VOID_P GLIB_SIZEOF_LONG GLIB_SIZEOF_SIZE_T @@ -127,6 +129,42 @@ GLIB_VERSION_2_44 GLIB_VERSION_MIN_REQUIRED GLIB_VERSION_MAX_ALLOWED GLIB_DISABLE_DEPRECATION_WARNINGS + + +G_ENCODE_VERSION +GLIB_AVAILABLE_IN_ALL +GLIB_AVAILABLE_IN_2_26 +GLIB_AVAILABLE_IN_2_28 +GLIB_AVAILABLE_IN_2_30 +GLIB_AVAILABLE_IN_2_32 +GLIB_AVAILABLE_IN_2_34 +GLIB_AVAILABLE_IN_2_36 +GLIB_AVAILABLE_IN_2_38 +GLIB_AVAILABLE_IN_2_40 +GLIB_AVAILABLE_IN_2_42 +GLIB_AVAILABLE_IN_2_44 +GLIB_DEPRECATED_IN_2_26 +GLIB_DEPRECATED_IN_2_26_FOR +GLIB_DEPRECATED_IN_2_28 +GLIB_DEPRECATED_IN_2_28_FOR +GLIB_DEPRECATED_IN_2_30 +GLIB_DEPRECATED_IN_2_30_FOR +GLIB_DEPRECATED_IN_2_32 +GLIB_DEPRECATED_IN_2_32_FOR +GLIB_DEPRECATED_IN_2_34 +GLIB_DEPRECATED_IN_2_34_FOR +GLIB_DEPRECATED_IN_2_36 +GLIB_DEPRECATED_IN_2_36_FOR +GLIB_DEPRECATED_IN_2_38 +GLIB_DEPRECATED_IN_2_38_FOR +GLIB_DEPRECATED_IN_2_40 +GLIB_DEPRECATED_IN_2_40_FOR +GLIB_DEPRECATED_IN_2_42 +GLIB_DEPRECATED_IN_2_42_FOR +GLIB_DEPRECATED_IN_2_44 +GLIB_DEPRECATED_IN_2_44_FOR +GLIB_VERSION_CUR_STABLE +GLIB_VERSION_PREV_STABLE
@@ -394,6 +432,9 @@ G_HAVE_GROWING_STACK G_VA_COPY_AS_ARRAY GLIB_DEPRECATED GLIB_DEPRECATED_FOR +GLIB_UNAVAILABLE +G_ANALYZER_ANALYZING +G_ANALYZER_NORETURN
@@ -567,6 +608,8 @@ G_WIN32_MSG_HANDLE g_idle_funcs g_timeout_funcs g_child_watch_funcs +g_unix_signal_funcs +g_unix_fd_source_funcs GSourcePrivate
@@ -907,6 +950,8 @@ g_io_channel_close g_io_channel_win32_poll g_io_channel_win32_make_pollfd g_io_channel_win32_get_fd +g_io_channel_win32_new_stream_socket +g_io_channel_win32_set_debug g_io_channel_error_quark g_io_watch_funcs G_IO_FLAG_IS_WRITEABLE @@ -1185,6 +1230,8 @@ g_option_context_get_help_enabled g_option_context_set_ignore_unknown_options g_option_context_get_ignore_unknown_options g_option_context_get_help +g_option_context_get_strict_posix +g_option_context_set_strict_posix GOptionArg GOptionFlags G_OPTION_REMAINING @@ -1894,6 +1941,8 @@ G_KEY_FILE_DESKTOP_KEY_CATEGORIES G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS G_KEY_FILE_DESKTOP_KEY_URL +G_KEY_FILE_DESKTOP_KEY_ACTIONS +G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE G_KEY_FILE_DESKTOP_TYPE_APPLICATION G_KEY_FILE_DESKTOP_TYPE_LINK G_KEY_FILE_DESKTOP_TYPE_DIRECTORY @@ -2062,6 +2111,7 @@ GSliceConfig g_slice_set_config g_slice_get_config g_slice_get_config_state +g_slice_debug_tree_statistics
diff --git a/glib/docs.c b/glib/docs.c index 5a20cf2..43c9f27 100644 --- a/glib/docs.c +++ b/glib/docs.c @@ -549,7 +549,7 @@ * G_GSIZE_MODIFIER: * * The platform dependent length modifier for conversion specifiers - * for scanning and printing values of type #gsize or #gssize. It + * for scanning and printing values of type #gsize. It * is a string literal. * * Since: 2.6 @@ -573,7 +573,7 @@ * to #G_MAXSSIZE. * * To print or scan values of this type, use - * %G_GSIZE_MODIFIER and/or %G_GSSIZE_FORMAT. + * %G_GSSIZE_MODIFIER and/or %G_GSSIZE_FORMAT. */ /** @@ -602,6 +602,16 @@ */ /** + * G_GSSIZE_MODIFIER: + * + * The platform dependent length modifier for conversion specifiers + * for scanning and printing values of type #gssize. It + * is a string literal. + * + * Since: 2.6 + */ + +/** * goffset: * * A signed integer type that is used for file offsets, diff --git a/glib/gconstructor.h b/glib/gconstructor.h index c5cff19..df98f83 100644 --- a/glib/gconstructor.h +++ b/glib/gconstructor.h @@ -16,6 +16,8 @@ */ +#ifndef __GTK_DOC_IGNORE__ + #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7) #define G_HAS_CONSTRUCTORS 1 @@ -89,3 +91,4 @@ #endif +#endif /* __GTK_DOC_IGNORE__ */ diff --git a/glib/gconvert.h b/glib/gconvert.h index 1b2369d..ba82a65 100644 --- a/glib/gconvert.h +++ b/glib/gconvert.h @@ -166,6 +166,7 @@ gchar *g_filename_display_basename (const gchar *filename) G_GNUC_MALLOC; GLIB_AVAILABLE_IN_ALL gchar **g_uri_list_extract_uris (const gchar *uri_list) G_GNUC_MALLOC; +#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 @@ -193,6 +194,7 @@ gchar *g_filename_to_uri_utf8 (const gchar *filename, const gchar *hostname, GError **error) G_GNUC_MALLOC; #endif +#endif /* __GTK_DOC_IGNORE__ */ G_END_DECLS diff --git a/glib/gdir.h b/glib/gdir.h index 6ff2455..b0dbb32 100644 --- a/glib/gdir.h +++ b/glib/gdir.h @@ -47,6 +47,7 @@ void g_dir_rewind (GDir *dir); GLIB_AVAILABLE_IN_ALL void g_dir_close (GDir *dir); +#ifndef __GTK_DOC_IGNORE__ #ifdef G_OS_WIN32 #define g_dir_open g_dir_open_utf8 #define g_dir_read_name g_dir_read_name_utf8 @@ -58,6 +59,7 @@ GDir *g_dir_open_utf8 (const gchar *path, GLIB_AVAILABLE_IN_ALL const gchar *g_dir_read_name_utf8 (GDir *dir); #endif /* G_OS_WIN32 */ +#endif /* __GTK_DOC_IGNORE__ */ G_END_DECLS diff --git a/glib/genviron.h b/glib/genviron.h index 7268a56..a4bcd41 100644 --- a/glib/genviron.h +++ b/glib/genviron.h @@ -58,6 +58,7 @@ GLIB_AVAILABLE_IN_ALL gchar ** g_environ_unsetenv (gchar **envp, const gchar *variable) G_GNUC_WARN_UNUSED_RESULT; +#ifndef __GTK_DOC_IGNORE__ #ifdef G_OS_WIN32 #define g_getenv g_getenv_utf8 #define g_setenv g_setenv_utf8 @@ -72,7 +73,7 @@ gboolean g_setenv_utf8 (const gchar *variable, GLIB_AVAILABLE_IN_ALL void g_unsetenv_utf8 (const gchar *variable); #endif - +#endif /* __GTK_DOC_IGNORE__ */ G_END_DECLS #endif /* __G_ENVIRON_H__ */ diff --git a/glib/gfileutils.h b/glib/gfileutils.h index 604c7fd..c08ba09 100644 --- a/glib/gfileutils.h +++ b/glib/gfileutils.h @@ -177,6 +177,7 @@ gchar *g_path_get_basename (const gchar *file_name) G_GNUC_MALLOC; GLIB_AVAILABLE_IN_ALL gchar *g_path_get_dirname (const gchar *file_name) G_GNUC_MALLOC; +#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 @@ -201,6 +202,7 @@ gint g_file_open_tmp_utf8 (const gchar *tmpl, GLIB_AVAILABLE_IN_ALL gchar *g_get_current_dir_utf8 (void); #endif /* G_OS_WIN32 */ +#endif /* __GTK_DOC_IGNORE__ */ G_END_DECLS diff --git a/glib/ghash.c b/glib/ghash.c index 913f739..41d05dc 100644 --- a/glib/ghash.c +++ b/glib/ghash.c @@ -1308,6 +1308,8 @@ g_hash_table_add (GHashTable *hash_table, * * Checks if @key is in @hash_table. * + * Returns: %TRUE if @key is in @hash_table, %FALSE otherwise. + * * Since: 2.32 **/ gboolean diff --git a/glib/giochannel.h b/glib/giochannel.h index ed098ed..3b6c09a 100644 --- a/glib/giochannel.h +++ b/glib/giochannel.h @@ -399,6 +399,7 @@ void g_io_channel_win32_set_debug (GIOChannel *channel, #endif +#ifndef __GTK_DOC_IGNORE__ #ifdef G_OS_WIN32 #define g_io_channel_new_file g_io_channel_new_file_utf8 @@ -407,6 +408,7 @@ GIOChannel *g_io_channel_new_file_utf8 (const gchar *filename, const gchar *mode, GError **error); #endif +#endif /* __GTK_DOC_IGNORE__ */ G_END_DECLS diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c index ed5ae21..b1383b0 100644 --- a/glib/gkeyfile.c +++ b/glib/gkeyfile.c @@ -383,7 +383,7 @@ */ /** - * G_KEY_FILE_DESKTOP_KEY_URL : + * G_KEY_FILE_DESKTOP_KEY_URL: * * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string * giving the URL to access. It is only valid for desktop entries @@ -393,6 +393,24 @@ */ /** + * G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true + * if the application is D-Bus activatable. + * + * Since: 2.38 + */ + +/** + * G_KEY_FILE_DESKTOP_KEY_ACTIONS: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list + * giving the available application actions. + * + * Since: 2.38 + */ + +/** * G_KEY_FILE_DESKTOP_TYPE_APPLICATION: * * The value of the #G_KEY_FILE_DESKTOP_KEY_TYPE, key for desktop diff --git a/glib/goption.c b/glib/goption.c index b9b23ba..10bbafd 100644 --- a/glib/goption.c +++ b/glib/goption.c @@ -488,6 +488,7 @@ g_option_context_get_ignore_unknown_options (GOptionContext *context) /** * g_option_context_set_strict_posix: * @context: a #GoptionContext + * @strict_posix: the new value * * Sets strict POSIX mode. * @@ -533,6 +534,8 @@ g_option_context_set_strict_posix (GOptionContext *context, * * See g_option_context_set_strict_posix() for more information. * + * Returns: %TRUE if strict POSIX is enabled, %FALSE otherwise. + * * Since: 2.44 **/ gboolean diff --git a/glib/gspawn.h b/glib/gspawn.h index eb7304b..bae522a 100644 --- a/glib/gspawn.h +++ b/glib/gspawn.h @@ -251,6 +251,7 @@ gboolean g_spawn_check_exit_status (gint exit_status, GLIB_AVAILABLE_IN_ALL void g_spawn_close_pid (GPid pid); +#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 @@ -301,6 +302,7 @@ GLIB_AVAILABLE_IN_ALL gboolean g_spawn_command_line_async_utf8 (const gchar *command_line, GError **error); #endif +#endif G_END_DECLS diff --git a/glib/gstdio.c b/glib/gstdio.c index 4fff212..92f1ba9 100644 --- a/glib/gstdio.c +++ b/glib/gstdio.c @@ -845,6 +845,8 @@ g_utime (const gchar *filename, * attempt to correctly handle %EINTR, which has platform-specific * semantics. * + * Returns: %TRUE on success, %FALSE if there was an error. + * * Since: 2.36 */ gboolean diff --git a/glib/gunicode.h b/glib/gunicode.h index 7ec6862..3109233 100644 --- a/glib/gunicode.h +++ b/glib/gunicode.h @@ -259,7 +259,7 @@ typedef enum * a value never returned from g_unichar_get_script() * @G_UNICODE_SCRIPT_COMMON: a character used by multiple different scripts * @G_UNICODE_SCRIPT_INHERITED: a mark glyph that takes its script from the - * i base glyph to which it is attached + * base glyph to which it is attached * @G_UNICODE_SCRIPT_ARABIC: Arabic * @G_UNICODE_SCRIPT_ARMENIAN: Armenian * @G_UNICODE_SCRIPT_BENGALI: Bengali @@ -393,7 +393,7 @@ typedef enum * @G_UNICODE_SCRIPT_PSALTER_PAHLAVI: Psalter Pahlavi. Since: 2.42 * @G_UNICODE_SCRIPT_SIDDHAM: Siddham. Since: 2.42 * @G_UNICODE_SCRIPT_TIRHUTA: Tirhuta. Since: 2.42 - * @G_UNICODE_SCRIPT_WARANG_CITI Warang Citi. Since: 2.42 + * @G_UNICODE_SCRIPT_WARANG_CITI: Warang Citi. Since: 2.42 * * The #GUnicodeScript enumeration identifies different writing * systems. The values correspond to the names as defined in the diff --git a/glib/gwin32.h b/glib/gwin32.h index b466b63..c7575c4 100644 --- a/glib/gwin32.h +++ b/glib/gwin32.h @@ -115,6 +115,7 @@ G_END_DECLS #endif /* G_PLATFORM_WIN32 */ +#ifndef __GTK_DOC_IGNORE__ #ifdef G_OS_WIN32 #ifdef _WIN64 #define g_win32_get_package_installation_directory g_win32_get_package_installation_directory_utf8 @@ -130,5 +131,6 @@ gchar *g_win32_get_package_installation_subdirectory_utf8 (const gchar *package, const gchar *subdir); #endif /* G_OS_WIN32 */ +#endif /* __GTK_DOC_IGNORE__ */ #endif /* __G_WIN32_H__ */ diff --git a/glib/valgrind.h b/glib/valgrind.h index 376fa74..565f7e5 100644 --- a/glib/valgrind.h +++ b/glib/valgrind.h @@ -55,7 +55,6 @@ ---------------------------------------------------------------- */ - /* This file is for inclusion into client (your!) code. You can use these macros to manipulate and query Valgrind's @@ -73,7 +72,6 @@ #ifndef __VALGRIND_H #define __VALGRIND_H - /* ------------------------------------------------------------------ */ /* VERSION NUMBER OF VALGRIND */ /* ------------------------------------------------------------------ */ -- 2.7.4