diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 579a61877..d78eaaf4c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,14 @@ +2005-06-29 Matthias Clasen + + * glib/tmpl/threads.sgml: + * glib/tmpl/option.sgml: + * glib/tmpl/fileutils.sgml: + * glib/tmpl/iochannels.sgml: + * glib/tmpl/hooks.sgml: + * glib/tmpl/misc_utils.sgml: + * glib/tmpl/date.sgml: + * glib/glib-sections.txt: Updates + 2005-06-24 Matthias Clasen * glib/glib-sections.txt: Add GMappedFile functions. diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 4db753b58..79ed47818 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -985,6 +985,7 @@ g_file_test g_mkstemp g_file_open_tmp g_file_read_link +g_mkdir_with_parents GDir @@ -1311,6 +1312,7 @@ g_get_system_data_dirs g_get_system_config_dirs +g_get_host_name g_get_home_dir g_get_tmp_dir g_get_current_dir diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml index 57d9cc87c..6669d1272 100644 --- a/docs/reference/glib/tmpl/date.sgml +++ b/docs/reference/glib/tmpl/date.sgml @@ -125,12 +125,14 @@ date becomes valid after you set it to a Julian day or you set a day, month, and year. -@julian_days: -@julian: -@dmy: -@day: -@month: -@year: +@julian_days: the Julian representation of the date +@julian: this bit is set if @julian_days is valid +@dmy: this is set if @day, @month and @year are valid +@day: the day of the day-month-year representation of the date, as + a number between 1 and 31 +@month: the day of the day-month-year representation of the date, as + a number between 1 and 12 +@year: the day of the day-month-year representation of the date @@ -144,9 +146,9 @@ This enumeration isn't used in the API, but may be useful if you need to mark a number as a day, month, or year. -@G_DATE_DAY: -@G_DATE_MONTH: -@G_DATE_YEAR: +@G_DATE_DAY: a day +@G_DATE_MONTH: a month +@G_DATE_YEAR: a year diff --git a/docs/reference/glib/tmpl/fileutils.sgml b/docs/reference/glib/tmpl/fileutils.sgml index e44064b6d..2cbc27bf3 100644 --- a/docs/reference/glib/tmpl/fileutils.sgml +++ b/docs/reference/glib/tmpl/fileutils.sgml @@ -262,6 +262,51 @@ An opaque structure representing an opened directory. @dir: + + +The #GMappedFile represents a file mapping created with +g_mapped_file_new(). It has only private members and should +not be accessed directly. + + + + + + + + +@filename: +@writable: +@error: +@Returns: + + + + + + + +@file: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + diff --git a/docs/reference/glib/tmpl/hooks.sgml b/docs/reference/glib/tmpl/hooks.sgml index 666e6d79b..adefb3034 100644 --- a/docs/reference/glib/tmpl/hooks.sgml +++ b/docs/reference/glib/tmpl/hooks.sgml @@ -346,7 +346,9 @@ Flags used internally in the #GHook implementation. @G_HOOK_FLAG_ACTIVE: set if the hook has not been destroyed. @G_HOOK_FLAG_IN_CALL: set if the hook is currently being run. -@G_HOOK_FLAG_MASK: +@G_HOOK_FLAG_MASK: A mask covering all bits reserved for + hook flags; see #G_HOOK_FLAGS_USER_SHIFT + diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml index 57219fcac..31bb7fe6e 100644 --- a/docs/reference/glib/tmpl/iochannels.sgml +++ b/docs/reference/glib/tmpl/iochannels.sgml @@ -564,10 +564,10 @@ g_io_channel_set_flags(). g_io_channel_write(), and g_io_channel_seek(). -@G_IO_ERROR_NONE: -@G_IO_ERROR_AGAIN: -@G_IO_ERROR_INVAL: -@G_IO_ERROR_UNKNOWN: +@G_IO_ERROR_NONE: no error +@G_IO_ERROR_AGAIN: an EAGAIN error occurred +@G_IO_ERROR_INVAL: an EINVAL error occurred +@G_IO_ERROR_UNKNOWN: another error occurred diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml index eb32d3bce..871a5bc58 100644 --- a/docs/reference/glib/tmpl/misc_utils.sgml +++ b/docs/reference/glib/tmpl/misc_utils.sgml @@ -233,6 +233,15 @@ The returned string should be freed when no longer needed. @Returns: + + + + + +@args: +@Returns: + + @@ -244,6 +253,16 @@ The returned string should be freed when no longer needed. @Returns: + + + + + +@separator: +@args: +@Returns: + + @@ -330,8 +349,8 @@ Associates a string with a bit flag. Used in g_parse_debug_string(). -@key: -@value: +@key: the string +@value: the flag diff --git a/docs/reference/glib/tmpl/option.sgml b/docs/reference/glib/tmpl/option.sgml index d0f6acd18..b0e52ed48 100644 --- a/docs/reference/glib/tmpl/option.sgml +++ b/docs/reference/glib/tmpl/option.sgml @@ -124,6 +124,9 @@ main (int argc, char *argv[]) + + + Error codes returned by option parsing. @@ -431,8 +434,6 @@ The type of function that can be called before and after parsing. @context The active #GOptionContext - -@context: @group: The group to which the function belongs @data: User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() @@ -458,8 +459,6 @@ occurs. @context The active #GOptionContext - -@context: @group: The group to which the function belongs @data: User data added to the #GOptionGroup containing the option when it was created with g_option_group_new() diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml index 69396e42c..48fe84e12 100644 --- a/docs/reference/glib/tmpl/threads.sgml +++ b/docs/reference/glib/tmpl/threads.sgml @@ -1621,13 +1621,14 @@ you should also free the #GStaticPrivate. -A GOnce struct controls a one-time initialization function. -Any one-time initialization function must have its own unique GOnce -struct. +A GOnce struct controls a one-time initialization +function. Any one-time initialization function must have its own unique +GOnce struct. -@status: -@retval: +@status: the status of the #GOnce +@retval: the value returned by the call to the function, if @status + is %G_ONCE_STATUS_READY @Since: 2.4 @@ -1657,17 +1658,20 @@ GOnce my_once = G_ONCE_INIT; -The first call to this routine by a process with a given #GOnce struct calls @func with the given -argument. Thereafter, subsequent calls to g_once() with the same #GOnce struct do not call @func -again, but return the stored result of the first call. On return from g_once(), the status of @once -will be %G_ONCE_STATUS_READY. +The first call to this routine by a process with a given #GOnce struct calls +@func with the given argument. Thereafter, subsequent calls to g_once() with +the same #GOnce struct do not call @func again, but return the stored result +of the first call. On return from g_once(), the status of @once will be +%G_ONCE_STATUS_READY. -For example, a mutex or a thread-specific data key must be created exactly once. In a threaded -environment, calling g_once() ensures that the initialization is serialized across multiple threads. +For example, a mutex or a thread-specific data key must be created exactly +once. In a threaded environment, calling g_once() ensures that the +initialization is serialized across multiple threads. -Calling g_once() recursively on the same #GOnce struct in @func will lead to a deadlock. +Calling g_once() recursively on the same #GOnce struct in @func will lead +to a deadlock. @@ -1686,8 +1690,9 @@ get_debug_flags () @once: a #GOnce structure -@func: the function associated to @once. This function is called only once, regardless of the - number of times it and its associated #GOnce struct are passed to g_once() . +@func: the function associated to @once. This function is called only once, + regardless of the number of times it and its associated #GOnce struct + are passed to g_once() . @arg: data to be passed to @func @Since: 2.4