From c72df49bf98e6dbc7d139e5f33445e826a3bb815 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 11 Nov 2001 00:27:27 +0000 Subject: [PATCH] Document GNormalizeMode enum. * glib/tmpl/unicode.sgml: Document GNormalizeMode enum. * glib/tmpl/spawn.sgml: Document GSpawnFlags flags. * glib/tmpl/error_reporting.sgml: Document GError struct. * glib/tmpl/main.sgml: Document GMainContext, GSource and GSourceCallbackFuncs structs. --- docs/reference/ChangeLog | 11 +++++++++ docs/reference/glib/tmpl/error_reporting.sgml | 3 ++- docs/reference/glib/tmpl/main.sgml | 21 ++++++++++------- docs/reference/glib/tmpl/spawn.sgml | 28 +++++++++++++++------- docs/reference/glib/tmpl/unicode.sgml | 34 +++++++++++++++++---------- 5 files changed, 66 insertions(+), 31 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 99410ca..0161116 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,14 @@ +2001-11-11 Matthias Clasen + + * glib/tmpl/unicode.sgml: Document GNormalizeMode enum. + + * glib/tmpl/spawn.sgml: Document GSpawnFlags flags. + + * glib/tmpl/error_reporting.sgml: Document GError struct. + + * glib/tmpl/main.sgml: Document GMainContext, GSource and + GSourceCallbackFuncs structs. + 2001-10-31 Matthias Clasen * glib/tmpl/messages.sgml, glib/tmpl/unicode.sgml: diff --git a/docs/reference/glib/tmpl/error_reporting.sgml b/docs/reference/glib/tmpl/error_reporting.sgml index 454c6e7..56842db 100644 --- a/docs/reference/glib/tmpl/error_reporting.sgml +++ b/docs/reference/glib/tmpl/error_reporting.sgml @@ -372,7 +372,8 @@ Summary of rules for use of #GError: - +The GError structure contains +information about an error that has occurred. @domain: error domain, e.g. #G_FILE_ERROR. diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index 19817ce..cbfc0f0 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -16,7 +16,7 @@ manages all available sources of events. To allow multiple independent sets of sources to be handled in different threads, each source is associated with a #GMainContext. A #GMainContext can only be running in a single thread, but - sources can be added and removed from it from other threads. + sources can be added to it and removed from it from other threads. Each event source is assigned a priority. The default priority, @@ -104,8 +104,8 @@ manages all available sources of events. -The #GMainLoop struct is an opaque data type representing the main event loop -of a GLib or GTK+ application. +The GMainLoop struct is an opaque data type +representing the main event loop of a GLib or GTK+ application. @@ -264,7 +264,8 @@ It is not used within GLib or GTK+. - +The GMainContext struct is an opaque data type +representing a set of sources to be handled in a main loop. @@ -618,7 +619,8 @@ you would use %G_IO_IN | %G_IO_HUP | %G_IO_ERR, and for writing you would use - +The GSource struct is an opaque data type representing +an event source. @@ -707,12 +709,13 @@ call to see if the required condition has been met, and returns %TRUE if so. - +The GSourceCallbackFuncs struct contains +functions for managing callback objects. -@ref: -@unref: -@get: +@ref: Called when a reference is added to the callback object. +@unref: Called when a reference to the callback object is dropped. +@get: Called to extract the callback function and data from the callback object. diff --git a/docs/reference/glib/tmpl/spawn.sgml b/docs/reference/glib/tmpl/spawn.sgml index 07e7dd6..633a93b 100644 --- a/docs/reference/glib/tmpl/spawn.sgml +++ b/docs/reference/glib/tmpl/spawn.sgml @@ -51,16 +51,28 @@ error domains. - +Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). -@G_SPAWN_LEAVE_DESCRIPTORS_OPEN: -@G_SPAWN_DO_NOT_REAP_CHILD: -@G_SPAWN_SEARCH_PATH: -@G_SPAWN_STDOUT_TO_DEV_NULL: -@G_SPAWN_STDERR_TO_DEV_NULL: -@G_SPAWN_CHILD_INHERITS_STDIN: -@G_SPAWN_FILE_AND_ARGV_ZERO: +@G_SPAWN_LEAVE_DESCRIPTORS_OPEN: the parent's open file descriptors will be + inherited by the child; otherwise all descriptors except stdin/stdout/stderr + will be closed before calling exec() in the child. +@G_SPAWN_DO_NOT_REAP_CHILD: the child will not be automatically reaped; you + must call waitpid() or handle SIGCHLD + yourself, or the child will become a zombie. +@G_SPAWN_SEARCH_PATH: argv[0] need not be an absolute path, + it will be looked for in the user's PATH. +@G_SPAWN_STDOUT_TO_DEV_NULL: the child's standad output will be discarded, + instead of going to the same location as the parent's standard output. +@G_SPAWN_STDERR_TO_DEV_NULL: the child's standard error will be discarded. +@G_SPAWN_CHILD_INHERITS_STDIN: the child will inherit the parent's standard + input (by default, the child's standard input is attached to + /dev/null). +@G_SPAWN_FILE_AND_ARGV_ZERO: the first element of argv is + the file to execute, while the remaining elements are the actual argument + vector to pass to the file. Normally g_spawn_async_with_pipes() uses + argv[0] as the file to execute, and passes all of + argv to the child. diff --git a/docs/reference/glib/tmpl/unicode.sgml b/docs/reference/glib/tmpl/unicode.sgml index 3c6287e..fabf29d 100644 --- a/docs/reference/glib/tmpl/unicode.sgml +++ b/docs/reference/glib/tmpl/unicode.sgml @@ -466,8 +466,6 @@ that may contain invalid UTF-8. @max_len: @end: @Returns: - -@len: @@ -513,17 +511,27 @@ that may contain invalid UTF-8. - - - -@G_NORMALIZE_DEFAULT: -@G_NORMALIZE_NFD: -@G_NORMALIZE_DEFAULT_COMPOSE: -@G_NORMALIZE_NFC: -@G_NORMALIZE_ALL: -@G_NORMALIZE_NFKD: -@G_NORMALIZE_ALL_COMPOSE: -@G_NORMALIZE_NFKC: +A #GNormalizeMode defines how a Unicode string is transformed in a canonical +form, standardizing such issues as whether a character with an accent is +represented as a base character and combining accent or as a single precomposed +character. Unicode strings should generally be normalized before comparing them. + + +@G_NORMALIZE_DEFAULT: standardize differences that do not affect the + text content, such as the above-mentioned accent representation. +@G_NORMALIZE_NFD: another name for %G_NORMALIZE_DEFAULT. +@G_NORMALIZE_DEFAULT_COMPOSE: like %G_NORMALIZE_DEFAULT, but with composed + forms rather than a maximally decomposed form. +@G_NORMALIZE_NFC: another name for %G_NORMALIZE_DEFAULT_COMPOSE. +@G_NORMALIZE_ALL: beyond %G_NORMALIZE_DEFAULT also standardize the + "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the + standard forms (in this case DIGIT THREE). Formatting information may be + lost but for most text operations such characters should be considered the + same. +@G_NORMALIZE_NFKD: another name for %G_NORMALIZE_ALL. +@G_NORMALIZE_ALL_COMPOSE: like %G_NORMALIZE_ALL, but with composed + forms rather than a maximally decomposed form. +@G_NORMALIZE_NFKC: another name for %G_NORMALIZE_ALL_COMPOSE. -- 2.7.4