luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-26 04:02:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc: glib: Fix all undocumented/unused/undeclared symbols

Browse Source 
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
This commit is contained in:
Xavier Claessens 2014-11-29 08:39:24 -05:00 committed by Ryan Lortie
parent b6aa0c4890
commit 1a2a689dea
18 changed files with 112 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/glib/Makefile.am
View File

@ -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 = \

5
docs/reference/glib/glib-overrides.txt
View File

@ -206,11 +206,6 @@ GCond *cond
#define G_OS_WIN32
</MACRO>
<MACRO>
<NAME>G_OS_BEOS</NAME>
#define G_OS_BEOS
</MACRO>
# g_ascii_isxxx
<FUNCTION>

50
docs/reference/glib/glib-sections.txt
View File

@ -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
<SUBSECTION Private>
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
<SUBSECTION Private>
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
</SECTION>
<SECTION>
@ -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
</SECTION>
<SECTION>
@ -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
</SECTION>
@ -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
</SECTION>
<SECTION>

14
glib/docs.c
View File

@ -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.
*/
/**
@ -601,6 +601,16 @@
* Since: 2.6
*/
/**
* 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:
*

3
glib/gconstructor.h
View File

@ -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__ */

2
glib/gconvert.h
View File

@ -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

2
glib/gdir.h
View File

@ -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

3
glib/genviron.h
View File

@ -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__ */

2
glib/gfileutils.h
View File

@ -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

2
glib/ghash.c
View File

@ -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

2
glib/giochannel.h
View File

@ -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

20
glib/gkeyfile.c
View File

@ -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
@ -392,6 +392,24 @@
* Since: 2.14
*/
/**
* 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:
*

3
glib/goption.c
View File

@ -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

2
glib/gspawn.h
View File

@ -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

2
glib/gstdio.c
View File

@ -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

4
glib/gunicode.h
View File

@ -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

2
glib/gwin32.h
View File

@ -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__ */

2
glib/valgrind.h
View File

@ -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 */
/* ------------------------------------------------------------------ */