luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes.

Browse Source
This commit is contained in:
Matthias Clasen 2004-10-26 16:10:52 +00:00
parent 537908e429
commit 5a6df6dd65
18 changed files with 1001 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,5 +1,10 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com> 2004-10-26 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c (g_key_file_new): Fix docs.
* glib/gkeyfile.h: Use the same parameter names as in
the implementation and the docs.
* glib/gwin32.c (g_win32_get_windows_version): Make this * glib/gwin32.c (g_win32_get_windows_version): Make this
function thread-safe in the GLib style. function thread-safe in the GLib style.
* glib/gthreadinit.h: * glib/gthreadinit.h:

5
ChangeLog.pre-2-10
View File

@ -1,5 +1,10 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com> 2004-10-26 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c (g_key_file_new): Fix docs.
* glib/gkeyfile.h: Use the same parameter names as in
the implementation and the docs.
* glib/gwin32.c (g_win32_get_windows_version): Make this * glib/gwin32.c (g_win32_get_windows_version): Make this
function thread-safe in the GLib style. function thread-safe in the GLib style.
* glib/gthreadinit.h: * glib/gthreadinit.h:

5
ChangeLog.pre-2-12
View File

@ -1,5 +1,10 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com> 2004-10-26 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c (g_key_file_new): Fix docs.
* glib/gkeyfile.h: Use the same parameter names as in
the implementation and the docs.
* glib/gwin32.c (g_win32_get_windows_version): Make this * glib/gwin32.c (g_win32_get_windows_version): Make this
function thread-safe in the GLib style. function thread-safe in the GLib style.
* glib/gthreadinit.h: * glib/gthreadinit.h:

5
ChangeLog.pre-2-6
View File

@ -1,5 +1,10 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com> 2004-10-26 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c (g_key_file_new): Fix docs.
* glib/gkeyfile.h: Use the same parameter names as in
the implementation and the docs.
* glib/gwin32.c (g_win32_get_windows_version): Make this * glib/gwin32.c (g_win32_get_windows_version): Make this
function thread-safe in the GLib style. function thread-safe in the GLib style.
* glib/gthreadinit.h: * glib/gthreadinit.h:

5
ChangeLog.pre-2-8
View File

@ -1,5 +1,10 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com> 2004-10-26 Matthias Clasen <mclasen@redhat.com>
* glib/gkeyfile.c (g_key_file_new): Fix docs.
* glib/gkeyfile.h: Use the same parameter names as in
the implementation and the docs.
* glib/gwin32.c (g_win32_get_windows_version): Make this * glib/gwin32.c (g_win32_get_windows_version): Make this
function thread-safe in the GLib style. function thread-safe in the GLib style.
* glib/gthreadinit.h: * glib/gthreadinit.h:

15
docs/reference/ChangeLog
View File

@ -1,3 +1,18 @@
2004-10-26 Matthias Clasen <mclasen@redhat.com>
* gobject/gobject-sections.txt: Additions.
* gobject/Makefile.am (IGNORE_HFILES): Add gobjectalias.h
* glib/tmpl/main.sgml: Document GChildWatchFunc
* glib/tmpl/keyfile.sgml: New template.
* glib/glib-sections.txt: Additions.
* glib/tmpl/macros_misc.sgml: Document some more of
the macros.
2004-10-25 Matthias Clasen <mclasen@redhat.com> 2004-10-25 Matthias Clasen <mclasen@redhat.com>
* glib/glib-docs.sgml: Add GKeyFile section, add * glib/glib-docs.sgml: Add GKeyFile section, add

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

@ -820,6 +820,7 @@ G_BREAKPOINT
<SUBSECTION Private> <SUBSECTION Private>
g_return_if_fail_warning g_return_if_fail_warning
g_assert_warning
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -959,7 +960,7 @@ GTranslateFunc
g_option_group_set_translate_func g_option_group_set_translate_func
g_option_group_set_translation_domain g_option_group_set_translation_domain
<SUBSECTION Private> <SUBSECTION Private>
g_option_context_error_quark g_option_error_quark
</SECTION> </SECTION>
@ -1400,28 +1401,34 @@ g_key_file_get_groups
g_key_file_get_keys g_key_file_get_keys
g_key_file_has_group g_key_file_has_group
g_key_file_has_key g_key_file_has_key
g_key_file_remove_group
g_key_file_remove_key
<SUBSECTION> <SUBSECTION>
g_key_file_get_value g_key_file_get_value
g_key_file_set_value
g_key_file_get_string g_key_file_get_string
g_key_file_set_string
g_key_file_get_locale_string g_key_file_get_locale_string
g_key_file_set_locale_string
g_key_file_get_boolean g_key_file_get_boolean
g_key_file_set_boolean
g_key_file_get_integer g_key_file_get_integer
g_key_file_set_integer
g_key_file_get_string_list g_key_file_get_string_list
g_key_file_set_string_list
g_key_file_get_locale_string_list g_key_file_get_locale_string_list
g_key_file_set_locale_string_list
g_key_file_get_boolean_list g_key_file_get_boolean_list
g_key_file_set_boolean_list
g_key_file_get_integer_list g_key_file_get_integer_list
g_key_file_get_comment
<SUBSECTION>
g_key_file_set_value
g_key_file_set_string
g_key_file_set_locale_string
g_key_file_set_boolean
g_key_file_set_integer
g_key_file_set_string_list
g_key_file_set_locale_string_list
g_key_file_set_boolean_list
g_key_file_set_integer_list g_key_file_set_integer_list
g_key_file_set_comment
g_key_file_remove_group
g_key_file_remove_key
g_key_file_remove_comment
<SUBSECTION Private> <SUBSECTION Private>
g_key_file_error_quark g_key_file_error_quark
</SECTION> </SECTION>
@ -1470,7 +1477,6 @@ g_completion_free
MAXPATHLEN MAXPATHLEN
pid_t pid_t
pipe pipe
ftruncate
g_win32_error_message g_win32_error_message
g_win32_getlocale g_win32_getlocale
@ -2060,6 +2066,7 @@ g_filename_to_utf8
g_filename_from_utf8 g_filename_from_utf8
g_filename_from_uri g_filename_from_uri
g_filename_to_uri g_filename_to_uri
g_uri_list_extract_uris
g_locale_from_utf8 g_locale_from_utf8
GConvertError GConvertError

9
docs/reference/glib/tmpl/conversions.sgml
View File

@ -316,6 +316,15 @@ error domains.
@Returns: @Returns:
<!-- ##### FUNCTION g_uri_list_extract_uris ##### -->
<para>
</para>
@uri_list:
@Returns:
<!-- ##### FUNCTION g_locale_from_utf8 ##### --> <!-- ##### FUNCTION g_locale_from_utf8 ##### -->
<para> <para>

403
docs/reference/glib/tmpl/glib-unused.sgml
View File

@ -1,3 +1,49 @@
<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Long_Description ##### -->
<para>
The "GDesktopEntry" parser is intended to parse files written to
the <ulink
url="http://www.freedesktop.org/Standards/desktop-entry-spec">Desktop
Entry Specification</ulink>. It supports deserialization of
desktop entries from files and in-memory data. Desktop entries
are used for a variety of things including menus, application
MIME type registration, and launchers.
</para>
<para>
To load an existing desktop entry from a data directory (as
returned by g_get_user_data_dir() and g_get_system_data_dirs())
use g_desktop_entry_new_from_data_dirs(). To load an existing
desktop entry from an arbitrary location on the file system use
g_desktop_entry_new_from_file(). If the desktop entry is already
in memory use g_desktop_entry_new_from_data(). Once the desktop
entry is loaded its keys can be queried using the g_desktop_entry_get
family of functions.
</para>
<para>
To create a new desktop entry first call g_desktop_entry_new().
Then, call the g_desktop_entry_set family of functions. Next,
call g_desktop_entry_to_data() to output the desktop entry to
a byte array, which can be written to disk or sent over a
network. Finally, call g_desktop_entry_free() to deallocate the
#GDesktopEntry object returned by g_desktop_entry_new().
</para>
<!-- ##### SECTION ./tmpl/desktop_entry.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Short_Description ##### -->
serializes and deserializes a desktop entry.
<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Title ##### -->
Desktop Entry Parser
<!-- ##### ENUM GChannelError ##### --> <!-- ##### ENUM GChannelError ##### -->
<para> <para>
@ -51,6 +97,46 @@
@s2: @s2:
@Returns: @Returns:
<!-- ##### STRUCT GDesktopEntry ##### -->
<para>
</para>
<!-- ##### ENUM GDesktopEntryError ##### -->
<para>
Error codes returned by desktop entry parsing.
</para>
@G_DESKTOP_ENTRY_ERROR_UNKNOWN_ENCODING: text being parsed is not UTF-8 and
cannot be guessed.
@G_DESKTOP_ENTRY_ERROR_BAD_START_GROUP: desktop entry does not start with a
legal start group.
@G_DESKTOP_ENTRY_ERROR_PARSE: desktop entry is empty or contains invalid
data.
@G_DESKTOP_ENTRY_ERROR_NOT_FOUND: valid desktop entry could not be found.
@G_DESKTOP_ENTRY_ERROR_KEY_NOT_FOUND: desktop entry does not have requested
key.
@G_DESKTOP_ENTRY_ERROR_GROUP_NOT_FOUND: desktop entry does not have requested
group
@G_DESKTOP_ENTRY_ERROR_INVALID_VALUE: desktop entry contains key which has
value that cannot be validated.
<!-- ##### ENUM GDesktopEntryFlags ##### -->
<para>
#GDesktopEntry supports a few flags for tweaking performance during
deserialization. #G_DESKTOP_ENTRY_DISCARD_COMMENTS and
#G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS will reduce memory footprint,
and #G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP will increase key lookup speed.
</para>
@G_DESKTOP_ENTRY_NONE: use parser defaults
@G_DESKTOP_ENTRY_DISCARD_COMMENTS: Discard all lines that are blank
or start with "#".
@G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS: Only retain translations that
are returned by g_get_language_names().
@G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP: Generate a lookup map for key names to make lookups constant time at the cost of more memory.
<!-- ##### USER_FUNCTION GErrorFunc ##### --> <!-- ##### USER_FUNCTION GErrorFunc ##### -->
<para> <para>
Specifies the type of function passed to g_set_error_handler(). Specifies the type of function passed to g_set_error_handler().
@ -105,6 +191,14 @@ Specifies the type of function passed to g_set_warning_handler().
</para> </para>
<!-- ##### MACRO G_DESKTOP_ENTRY_ERROR ##### -->
<para>
Error domain for desktop entry parsing. Errors in this domain will
be from the #GDesktopEntryError enumeration. See #GError for information on
error domains.
</para>
<!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### --> <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
<para> <para>
@ -211,25 +305,328 @@ in any UNIX manual.
@Returns: @Returns:
<!-- ##### FUNCTION g_get_language_names ##### --> <!-- ##### FUNCTION g_desktop_entry_escape_strings ##### -->
<para> <para>
</para> </para>
@entry:
@should_escape:
<!-- ##### FUNCTION g_desktop_entry_free ##### -->
<para>
</para>
@entry:
<!-- ##### FUNCTION g_desktop_entry_get_boolean ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@error:
@Returns: @Returns:
<!-- ##### FUNCTION g_get_system_config_dirs ##### --> <!-- ##### FUNCTION g_desktop_entry_get_boolean_list ##### -->
<para> <para>
</para> </para>
@entry:
@group_name:
@key:
@length:
@error:
@Returns: @Returns:
<!-- ##### FUNCTION g_get_system_data_dirs ##### --> <!-- ##### FUNCTION g_desktop_entry_get_groups ##### -->
<para> <para>
</para> </para>
@entry:
@length:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_integer ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_integer_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_keys ##### -->
<para>
</para>
@entry:
@group_name:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_locale_string ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@locale:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_locale_string_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@locale:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_start_group ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_string ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_get_string_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_has_group ##### -->
<para>
</para>
@entry:
@group_name:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_has_key ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_new ##### -->
<para>
</para>
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_new_from_data ##### -->
<para>
</para>
@data:
@length:
@legal_start_groups:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_new_from_data_dirs ##### -->
<para>
</para>
@file:
@full_path:
@legal_start_groups:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_new_from_file ##### -->
<para>
</para>
@file:
@legal_start_groups:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_desktop_entry_remove_group ##### -->
<para>
</para>
@entry:
@group_name:
@error:
<!-- ##### FUNCTION g_desktop_entry_remove_key ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_boolean ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@boolean:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_boolean_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@list:
@length:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_integer ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@integer:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_integer_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@list:
@length:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_locale_string ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@locale:
@string:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_locale_string_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@locale:
@list:
@length:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_string ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@string:
@error:
<!-- ##### FUNCTION g_desktop_entry_set_string_list ##### -->
<para>
</para>
@entry:
@group_name:
@key:
@list:
@length:
@error:
<!-- ##### FUNCTION g_desktop_entry_to_data ##### -->
<para>
</para>
@entry:
@length:
@error:
@Returns: @Returns:
<!-- ##### FUNCTION g_io_channel_error_quark ##### --> <!-- ##### FUNCTION g_io_channel_error_quark ##### -->

8
docs/reference/glib/tmpl/i18n.sgml
View File

@ -93,3 +93,11 @@ be directly used, e.g. in string array initializers.
@Returns: @Returns:
<!-- ##### FUNCTION g_get_language_names ##### -->
<para>
</para>
@Returns:

463
docs/reference/glib/tmpl/keyfile.sgml Normal file
View File

@ -0,0 +1,463 @@
<!-- ##### SECTION Title ##### -->
Key-value file parser
<!-- ##### SECTION Short_Description ##### -->
parses <filename>.ini</filename>-like config files
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GKeyFile ##### -->
<para>
The <structname>GKeyFile</structname> struct contains only private fields
and should not be used directly.
</para>
<!-- ##### MACRO G_KEY_FILE_ERROR ##### -->
<para>
Error domain for key file parsing. Errors in this domain will
be from the #GKeyFileError enumeration. See #GError for information on
error domains.
</para>
<!-- ##### ENUM GKeyFileError ##### -->
<para>
Error codes returned by key file parsing.
</para>
@G_KEY_FILE_ERROR_UNKNOWN_ENCODING: the text being parsed was in an unknown encoding
@G_KEY_FILE_ERROR_PARSE: document was ill-formed
@G_KEY_FILE_ERROR_NOT_FOUND: the file was not found
@G_KEY_FILE_ERROR_KEY_NOT_FOUND: a requested key was not found
@G_KEY_FILE_ERROR_GROUP_NOT_FOUND: a requested group was not found
@G_KEY_FILE_ERROR_INVALID_VALUE: a value could not be parsed
<!-- ##### ENUM GKeyFileFlags ##### -->
<para>
Flags which influence the parsing.
</para>
@G_KEY_FILE_NONE: No flags, default behaviour
@G_KEY_FILE_KEEP_COMMENTS: Use this flag if you plan to write the (possibly modified)
contents of the key file back to a file; otherwise all comments will be lost when
the key file is written back.
@G_KEY_FILE_KEEP_TRANSLATIONS: Use this flag if you plan to write the (possibly modified)
contents of the key file back to a file; otherwise only the translations for the current
language will be written back.
<!-- ##### FUNCTION g_key_file_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_key_file_free ##### -->
<para>
</para>
@key_file:
<!-- ##### FUNCTION g_key_file_set_list_separator ##### -->
<para>
</para>
@key_file:
@separator:
<!-- ##### FUNCTION g_key_file_load_from_file ##### -->
<para>
</para>
@key_file:
@file:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_load_from_data ##### -->
<para>
</para>
@key_file:
@data:
@length:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_load_from_data_dirs ##### -->
<para>
</para>
@key_file:
@file:
@full_path:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_to_data ##### -->
<para>
</para>
@key_file:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_start_group ##### -->
<para>
</para>
@key_file:
@Returns:
<!-- ##### FUNCTION g_key_file_get_groups ##### -->
<para>
</para>
@key_file:
@length:
@Returns:
<!-- ##### FUNCTION g_key_file_get_keys ##### -->
<para>
</para>
@key_file:
@group_name:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_has_group ##### -->
<para>
</para>
@key_file:
@group_name:
@Returns:
<!-- ##### FUNCTION g_key_file_has_key ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_value ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_string ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_locale_string ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@locale:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_boolean ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_integer ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_string_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_locale_string_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@locale:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_boolean_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_integer_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_get_comment ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
@Returns:
<!-- ##### FUNCTION g_key_file_set_value ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@value:
<!-- ##### FUNCTION g_key_file_set_string ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@string:
<!-- ##### FUNCTION g_key_file_set_locale_string ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@locale:
@string:
<!-- ##### FUNCTION g_key_file_set_boolean ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@value:
<!-- # Unused Parameters # -->
@boolean:
<!-- ##### FUNCTION g_key_file_set_integer ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@value:
<!-- # Unused Parameters # -->
@integer:
<!-- ##### FUNCTION g_key_file_set_string_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@list:
@length:
<!-- ##### FUNCTION g_key_file_set_locale_string_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@locale:
@list:
@length:
<!-- ##### FUNCTION g_key_file_set_boolean_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@list:
@length:
<!-- ##### FUNCTION g_key_file_set_integer_list ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@list:
@length:
<!-- ##### FUNCTION g_key_file_set_comment ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@comment:
@error:
<!-- ##### FUNCTION g_key_file_remove_group ##### -->
<para>
</para>
@key_file:
@group_name:
@error:
<!-- ##### FUNCTION g_key_file_remove_key ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:
<!-- ##### FUNCTION g_key_file_remove_comment ##### -->
<para>
</para>
@key_file:
@group_name:
@key:
@error:

37
docs/reference/glib/tmpl/macros_misc.sgml
View File

@ -253,18 +253,20 @@ See the GNU C documentation for details.
<!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### --> <!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### -->
<para> <para>
This macro is defined as 1 if the the compiler supports ELF visibility
attributes (currently only <command>gcc</command>).
</para> </para>
Since: 2.6
<!-- ##### MACRO G_GNUC_INTERNAL ##### --> <!-- ##### MACRO G_GNUC_INTERNAL ##### -->
<para> <para>
Expands to the GNU C <literal>visibility(hidden)</literal> attribute if the Expands to the GNU C <literal>visibility(hidden)</literal> attribute if the
compiler is <command>gcc</command>. This attribute can be used for marking compiler supports it (currently only <command>gcc</command>). This attribute
library functions as being used internally to the lib only, to not create can be used for marking library functions as being used internally to the lib
inefficient PLT entries. Note that static functions do not need to be marked only, to not create inefficient PLT entries. Note that static functions do not
as internal in this way. See the GNU C documentation for details. need to be marked as internal in this way. See the GNU C documentation for details.
</para> </para>
Since: 2.6 Since: 2.6
@ -308,17 +310,18 @@ Expands to a string identifying the current code position.
<!-- ##### MACRO G_STRFUNC ##### --> <!-- ##### MACRO G_STRFUNC ##### -->
<para> <para>
Expands to a string identifying the current function.
</para> </para>
@Since: 2.4
<!-- ##### MACRO G_GINT16_MODIFIER ##### --> <!-- ##### MACRO G_GINT16_MODIFIER ##### -->
<para> <para>
The platform dependent length modifier for constructing printf() conversion The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint16. It is a string literal, but doesn't specifiers for values of type #gint16 or #guint16. It is a string literal,
include the percent-sign, such that you can add precision and length but doesn't include the percent-sign, such that you can add precision and
modifiers between percent-sign and conversion specifier and append a length modifiers between percent-sign and conversion specifier and append a
conversion specifier. conversion specifier.
</para> </para>
@ -368,7 +371,7 @@ printing values of type #guint16. See also #G_GINT16_FORMAT.
<!-- ##### MACRO G_GINT32_MODIFIER ##### --> <!-- ##### MACRO G_GINT32_MODIFIER ##### -->
<para> <para>
The platform dependent length modifier for constructing printf() conversion The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint32. See also #G_GINT16_MODIFIER. specifiers for values of type #gint32 or #guint32. See also #G_GINT16_MODIFIER.
</para> </para>
@Since: 2.4 @Since: 2.4
@ -393,7 +396,7 @@ printing values of type #guint32. See also #G_GINT16_FORMAT.
<!-- ##### MACRO G_GINT64_MODIFIER ##### --> <!-- ##### MACRO G_GINT64_MODIFIER ##### -->
<para> <para>
The platform dependent length modifier for constructing printf() conversion The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint64. See also #G_GINT16_MODIFIER. specifiers for values of type #gint64 or #guint64. See also #G_GINT16_MODIFIER.
</para> </para>
<note> <note>
@ -445,22 +448,28 @@ recommended for parsing anyway; consider using g_strtoull() instead.
<!-- ##### MACRO G_GSIZE_MODIFIER ##### --> <!-- ##### MACRO G_GSIZE_MODIFIER ##### -->
<para> <para>
The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gsize or #gssize. See also #G_GINT16_MODIFIER.
</para> </para>
@Since: 2.6
<!-- ##### MACRO G_GSIZE_FORMAT ##### --> <!-- ##### MACRO G_GSIZE_FORMAT ##### -->
<para> <para>
This is the platform dependent conversion specifier for scanning and
printing values of type #gsize. See also #G_GINT16_FORMAT.
</para> </para>
@Since: 2.6
<!-- ##### MACRO G_GSSIZE_FORMAT ##### --> <!-- ##### MACRO G_GSSIZE_FORMAT ##### -->
<para> <para>
This is the platform dependent conversion specifier for scanning and
printing values of type #gssize. See also #G_GINT16_FORMAT.
</para> </para>
@Since: 2.6

14
docs/reference/glib/tmpl/main.sgml
View File

@ -595,18 +595,22 @@ for the default main context.
<!-- ##### TYPEDEF GPid ##### --> <!-- ##### TYPEDEF GPid ##### -->
<para> <para>
A type which is used to hold a process identification.
On Unix, processes are identified by a process id (an
integer), while Windows uses process handles (which are
pointers).
</para> </para>
<!-- ##### USER_FUNCTION GChildWatchFunc ##### --> <!-- ##### USER_FUNCTION GChildWatchFunc ##### -->
<para> <para>
The type of functions to be called when a child exists.
</para> </para>
@pid: @pid: the process id of the child process
@status: @status: Status information about the child process,
@data: see waitpid(2) for more information about this field
@data: user data passed to g_child_watch_add()
<!-- ##### FUNCTION g_child_watch_source_new ##### --> <!-- ##### FUNCTION g_child_watch_source_new ##### -->

16
docs/reference/glib/tmpl/misc_utils.sgml
View File

@ -123,6 +123,22 @@ returned.
@Returns: @Returns:
<!-- ##### FUNCTION g_get_system_data_dirs ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_get_system_config_dirs ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_get_home_dir ##### --> <!-- ##### FUNCTION g_get_home_dir ##### -->
<para> <para>
Gets the current user's home directory. Gets the current user's home directory.

3
docs/reference/gobject/Makefile.am
View File

@ -15,6 +15,9 @@ DOC_SOURCE_DIR=../../../gobject
HFILE_GLOB=$(top_srcdir)/gobject/*.h HFILE_GLOB=$(top_srcdir)/gobject/*.h
CFILE_GLOB=$(top_srcdir)/gobject/*.c CFILE_GLOB=$(top_srcdir)/gobject/*.c
# Headers to ignore
IGNORE_HFILES=gobjectalias.h
# CFLAGS and LDFLAGS for compiling scan program. Only needed # CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty. # if $(DOC_MODULE).types is non-empty.
INCLUDES = \ INCLUDES = \

9
docs/reference/gobject/gobject-sections.txt
View File

@ -150,6 +150,15 @@ G_TYPE_RESERVED_USER_FIRST
<SUBSECTION Private> <SUBSECTION Private>
GOBJECT_VAR GOBJECT_VAR
g_value_c_init
g_value_types_init
g_enum_types_init
g_param_type_init
g_boxed_type_init
g_object_type_init
g_param_spec_types_init
g_value_transforms_init
g_signal_init
</SECTION> </SECTION>
<SECTION> <SECTION>

1
glib/gkeyfile.c
View File

@ -216,7 +216,6 @@ g_key_file_clear (GKeyFile *key_file)
/** /**
* g_key_file_new: * g_key_file_new:
* @flags: flags from #GKeyFileFlags
* *
* Creates a new empty #GKeyFile object. Use g_key_file_load_from_file(), * Creates a new empty #GKeyFile object. Use g_key_file_load_from_file(),
* g_key_file_load_from_data() or g_key_file_load_from_data_dirs() to * g_key_file_load_from_data() or g_key_file_load_from_data_dirs() to

4
glib/gkeyfile.h
View File

@ -117,7 +117,7 @@ gboolean g_key_file_get_boolean (GKeyFile *key_file,
void g_key_file_set_boolean (GKeyFile *key_file, void g_key_file_set_boolean (GKeyFile *key_file,
const gchar *group_name, const gchar *group_name,
const gchar *key, const gchar *key,
gboolean boolean); gboolean value);
gint g_key_file_get_integer (GKeyFile *key_file, gint g_key_file_get_integer (GKeyFile *key_file,
const gchar *group_name, const gchar *group_name,
const gchar *key, const gchar *key,
@ -125,7 +125,7 @@ gint g_key_file_get_integer (GKeyFile *key_file,
void g_key_file_set_integer (GKeyFile *key_file, void g_key_file_set_integer (GKeyFile *key_file,
const gchar *group_name, const gchar *group_name,
const gchar *key, const gchar *key,
gint integer); gint value);
gchar **g_key_file_get_string_list (GKeyFile *key_file, gchar **g_key_file_get_string_list (GKeyFile *key_file,
const gchar *group_name, const gchar *group_name,
const gchar *key, const gchar *key,