doc builds.
authorTim Janik <timj@src.gnome.org>
Sat, 6 Oct 2001 09:25:09 +0000 (09:25 +0000)
committerTim Janik <timj@src.gnome.org>
Sat, 6 Oct 2001 09:25:09 +0000 (09:25 +0000)
21 files changed:
docs/reference/glib/tmpl/arrays.sgml
docs/reference/glib/tmpl/arrays_byte.sgml
docs/reference/glib/tmpl/arrays_pointer.sgml
docs/reference/glib/tmpl/completion.sgml
docs/reference/glib/tmpl/conversions.sgml
docs/reference/glib/tmpl/date.sgml
docs/reference/glib/tmpl/glib-unused.sgml
docs/reference/glib/tmpl/hooks.sgml
docs/reference/glib/tmpl/iochannels.sgml
docs/reference/glib/tmpl/macros_misc.sgml
docs/reference/glib/tmpl/memory.sgml
docs/reference/glib/tmpl/patterns.sgml
docs/reference/glib/tmpl/scanner.sgml
docs/reference/glib/tmpl/shell.sgml
docs/reference/glib/tmpl/spawn.sgml
docs/reference/glib/tmpl/threads.sgml
docs/reference/glib/tmpl/trash_stack.sgml
docs/reference/glib/tmpl/type_conversion.sgml
docs/reference/glib/tmpl/unicode.sgml
docs/reference/glib/tmpl/windows.sgml
docs/reference/gobject/tmpl/types.sgml

index fa88905..0de6c90 100644 (file)
@@ -276,5 +276,6 @@ If @free_segment is %TRUE it frees the actual element data as well.
 
 @array: a #GArray.
 @free_segment: if %TRUE the actual element data is freed as well.
+@Returns: 
 
 
index 4ba9330..447f136 100644 (file)
@@ -164,5 +164,6 @@ If free_segment is %TRUE it frees the actual byte data.
 
 @array: a #GByteArray.
 @free_segment: if %TRUE the actual byte data is freed as well.
+@Returns: 
 
 
index 48f443c..74dc81b 100644 (file)
@@ -207,5 +207,6 @@ Frees all of the memory allocated for the pointer array.
 
 @array: a #GPtrArray.
 @free_seg: if %TRUE the actual element data is freed as well.
+@Returns: 
 
 
index 24d6e91..b2d9a03 100644 (file)
@@ -137,7 +137,7 @@ This is used when you use strings as #GCompletion items.
 first @n bytes of @s1 is found, respectively, to be less than, to match, 
 or to be greater than the first @n bytes of @s2.
 
+
 <!-- ##### FUNCTION g_completion_free ##### -->
 <para>
 Frees all memory used by the #GCompletion.
index 4e2bc7c..c43a987 100644 (file)
@@ -180,10 +180,10 @@ Error codes returned by character set conversion routines.
 </para>
 
 @G_CONVERT_ERROR_NO_CONVERSION: Conversion between the requested character sets
-is not supported. 
+is not supported.
 @G_CONVERT_ERROR_ILLEGAL_SEQUENCE: Invalid byte sequence in conversion input.
-@G_CONVERT_ERROR_FAILED: Conversion failed for some reason. 
+@G_CONVERT_ERROR_FAILED: Conversion failed for some reason.
 @G_CONVERT_ERROR_PARTIAL_INPUT: Partial character sequence at end of input.
-@G_CONVERT_ERROR_BAD_URI: URI is invalid. 
+@G_CONVERT_ERROR_BAD_URI: URI is invalid.
 @G_CONVERT_ERROR_NOT_ABSOLUTE_PATH: Pathname is not an absolute path.
 
index ad739e7..5fe0191 100644 (file)
@@ -87,7 +87,7 @@ Equivalent to <function>gettimeofday()</function>, but also works on
 Win32. Returns the current time.
 </para>
 
-@result:
+@result: 
 
 
 <!-- ##### FUNCTION g_usleep ##### -->
@@ -556,7 +556,6 @@ Returns %TRUE if the date is the last day of the month. The date must be valid.
 @Returns: %TRUE if the date is the last day of the month.
 
 
-
 <!-- ##### FUNCTION g_date_is_leap_year ##### -->
 <para>
 Returns %TRUE if the year is a leap year.
index 6d6c397..4ea5f2d 100644 (file)
@@ -131,6 +131,14 @@ not work.
 </para>
 
 
+<!-- ##### MACRO NAME_MAX ##### -->
+<para>
+Provided for UNIX emulation on Windows; equivalent to UNIX macro 
+%NAME_MAX, which is the maximum length of a single path component.
+i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
+</para>
+
+
 <!-- ##### MACRO access ##### -->
 <para>
 
@@ -171,6 +179,13 @@ not work.
 
 @Returns: 
 
+<!-- ##### FUNCTION g_io_channel_error_quark ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
 <!-- ##### FUNCTION g_main_add_poll ##### -->
 <para>
 Adds a file descriptor to be polled.
@@ -378,6 +393,13 @@ Turns the argument into a string literal by using the '#' stringizing operator.
 </para>
 
 
+<!-- ##### MACRO readdir ##### -->
+<para>
+Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
+in any UNIX manual.
+</para>
+
+
 <!-- ##### MACRO write ##### -->
 <para>
 
index 35d804f..de5f5c2 100644 (file)
@@ -67,7 +67,6 @@ function.</entry>
 @hook_memchunk: 
 @finalize_hook: 
 
-
 <!-- ##### USER_FUNCTION GHookFinalizeFunc ##### -->
 <para>
 Defines the type of function to be called when a hook in a 
@@ -156,7 +155,7 @@ by g_hook_list_invoke_check().
 </para>
 
 @data: the data field of the #GHook is passed to the hook function here.
-@Returns: %FALSE if the #GHook should be destroyed. 
+@Returns: %FALSE if the #GHook should be destroyed.
 
 
 <!-- ##### FUNCTION g_hook_list_init ##### -->
@@ -421,8 +420,8 @@ thread) are considered valid. If set to %FALSE, these are skipped.
 Flags used internally in the #GHook implementation.
 </para>
 
-@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_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: 
 
 <!-- ##### MACRO G_HOOK_FLAGS ##### -->
index f6d2d5a..91a5b68 100644 (file)
@@ -279,7 +279,7 @@ operation.
 Stati returned by most of the #GIOFuncs functions. 
 </para>
 
-@G_IO_STATUS_ERROR: An error occurred. 
+@G_IO_STATUS_ERROR: An error occurred.
 @G_IO_STATUS_NORMAL: Success.
 @G_IO_STATUS_EOF: End of file.
 @G_IO_STATUS_AGAIN: Resource temporarily unavailable.
@@ -308,14 +308,6 @@ error domains.
 
 
 
-<!-- ##### FUNCTION g_io_channel_error_quark ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-
 <!-- ##### FUNCTION g_io_channel_error_from_errno ##### -->
 <para>
 
index 11c15a1..16d2ac2 100644 (file)
@@ -77,6 +77,7 @@ yourself, because this macro may use <function>memmove()</function> and GLib
 does not include <function>string.h</function> for you.
 </para>
 
+<!-- # Unused Parameters # -->
 @ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
 @ap2: a <type>va_list</type>.
 
@@ -98,6 +99,23 @@ when compiling with the <literal>-pedantic</literal> option.
 
 
 
+<!-- ##### MACRO G_GNUC_CONST ##### -->
+<para>
+Expands to the GNU C const function attribute if the compiler is GNU C.
+Declaring a function as const enables better optimization of the function.
+A const function doesn't examine any values except its parameters,
+and has no effects except its return value.
+See the GNU C documentation for details. 
+</para>
+<note><para>
+A function that has pointer arguments and examines the data pointed to 
+must <emphasis>not</emphasis> be declared const. Likewise, a function that 
+calls a non-const function usually must not be const. It doesn't make sense 
+for a const function to return void.
+</para></note>
+
+
+
 <!-- ##### MACRO G_GNUC_NORETURN ##### -->
 <para>
 Expands to the GNU C noreturn function attribute if the compiler is GNU C.
@@ -127,21 +145,6 @@ See the GNU C documentation for details.
 </para>
 
 
-<!-- ##### MACRO G_GNUC_CONST ##### -->
-<para>
-Expands to the GNU C const function attribute if the compiler is GNU C.
-Declaring a function as const enables better optimization of the function.
-A const function doesn't examine any values except its parameters,
-and has no effects except its return value.
-See the GNU C documentation for details. 
-</para>
-<note><para>
-A function that has pointer arguments and examines the data pointed to 
-must <emphasis>not</emphasis> be declared const. Likewise, a function that 
-calls a non-const function usually must not be const. It doesn't make sense 
-for a const function to return void.
-</para></note>
-
 
 <!-- ##### MACRO G_GNUC_PRINTF ##### -->
 <para>
index 1b932b7..ee61d66 100644 (file)
@@ -220,3 +220,4 @@ previously installed the #glib_mem_profiler_table with g_mem_set_vtable().
 </para>
 
 
+
index cfea474..b1ad4fa 100644 (file)
@@ -24,6 +24,7 @@ g_pattern_spec_new() and use g_pattern_match_string() instead of
 g_pattern_match_simple().  This avoids the overhead of repeated 
 pattern compilation.
 </para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
@@ -35,11 +36,11 @@ Enumeration representing different kinds of patterns. This is only used
 internally for optimizing the match algorithm.
 </para>
 
-@G_MATCH_ALL: a general pattern. 
+@G_MATCH_ALL: a general pattern.
 @G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
 the end of the string.
 @G_MATCH_HEAD: a pattern matching every string with a certain prefix.
-@G_MATCH_TAIL: a pattern matching every string with a certain suffix. 
+@G_MATCH_TAIL: a pattern matching every string with a certain suffix.
 @G_MATCH_EXACT: a pattern matching exactly one string.
 @G_MATCH_LAST: 
 
@@ -101,4 +102,6 @@ Matches a string against a pattern.
 
 @pattern: the pattern.
 @string: the string to match.
-@Returns: %TRUE if @string matches @pspec. 
+@Returns: %TRUE if @string matches @pspec.
+
+
index 47fe157..b49baf6 100644 (file)
@@ -356,7 +356,6 @@ value of each pair, and the given @user_data parameter.
 @user_data: user data to pass to the function.
 
 
-
 <!-- ##### FUNCTION g_scanner_scope_lookup_symbol ##### -->
 <para>
 Looks up a symbol in a scope and return its value. If the
@@ -367,7 +366,7 @@ symbol is not bound in the scope, %NULL is returned.
 @scope_id: the scope id.
 @symbol: the symbol to look up.
 @Returns: the value of @symbol in the given scope, or %NULL
-if @symbol is not bound in the given scope. 
+if @symbol is not bound in the given scope.
 
 
 <!-- ##### FUNCTION g_scanner_scope_remove_symbol ##### -->
@@ -386,7 +385,7 @@ This function is deprecated and will be removed in the next major
 release of GLib. It does nothing.
 </para>
 
-@scanner: a #GScanner. 
+@scanner: a #GScanner.
 
 
 <!-- ##### MACRO g_scanner_thaw_symbol_table ##### -->
@@ -404,10 +403,10 @@ Looks up a symbol in the current scope and return its value. If the
 symbol is not bound in the current scope, %NULL is returned.
 </para>
 
-@scanner: a #GScanner. 
+@scanner: a #GScanner.
 @symbol: the symbol to look up.
 @Returns: the value of @symbol in the current scope, or %NULL
-if @symbol is not bound in the current scope. 
+if @symbol is not bound in the current scope.
 
 
 <!-- ##### FUNCTION g_scanner_warn ##### -->
@@ -457,7 +456,7 @@ warning.
 Specifies the type of the message handler function.
 </para>
 
-@scanner: a #GScanner. 
+@scanner: a #GScanner.
 @message: the message.
 @error: %TRUE if the message signals an error, %FALSE if it 
   signals a warning.
@@ -478,30 +477,8 @@ The possible types of token returned from each g_scanner_get_next_token() call.
 
 @G_TOKEN_EOF: the end of the file.
 @G_TOKEN_LEFT_PAREN: a '(' character.
-@G_TOKEN_RIGHT_PAREN: a ')' character.
-@G_TOKEN_LEFT_CURLY: a '{' character. 
+@G_TOKEN_LEFT_CURLY: a '{' character.
 @G_TOKEN_RIGHT_CURLY: a '}' character.
-@G_TOKEN_LEFT_BRACE: a '[' character.
-@G_TOKEN_RIGHT_BRACE: a ']' character.
-@G_TOKEN_EQUAL_SIGN: a '=' character. 
-@G_TOKEN_COMMA: a ',' character.
-@G_TOKEN_NONE: no token.
-@G_TOKEN_ERROR: an error. See #GErrorType for a list of possible errors. 
-@G_TOKEN_CHAR: a character without special meaning.
-@G_TOKEN_BINARY: an integer, specified in binary notation with a '0b' prefix.
-@G_TOKEN_OCTAL: an integer, specified in octal notation with a '0' prefix.
-@G_TOKEN_INT: an integer, specified in the usual decimal notation.
-@G_TOKEN_HEX: an integer, specified in hexadecimal notation with a '0x' or '$' prefix.
-@G_TOKEN_FLOAT: a floating point number.
-@G_TOKEN_STRING: a string enclosed in single or double quotes.
-@G_TOKEN_SYMBOL: a symbol which has been defined before.
-@G_TOKEN_IDENTIFIER: an identifier.
-@G_TOKEN_IDENTIFIER_NULL: the special identifier <literal>NULL</literal>.
-@G_TOKEN_COMMENT_SINGLE: a single-line comment enclosed in the delimiters
-  specified by <structfield>cpair_comment_single</structfield>.
-@G_TOKEN_COMMENT_MULTI: a multi-line comment enclosed in '/*' and '*/'.
-@G_TOKEN_LAST: 
-
 
 <!-- ##### UNION GTokenValue ##### -->
 <para>
@@ -516,7 +493,7 @@ of #GTokenValue, when the token is a #G_TOKEN_ERROR.
 </para>
 
 @G_ERR_UNKNOWN: unknown error.
-@G_ERR_UNEXP_EOF: unexpected end of file. 
+@G_ERR_UNEXP_EOF: unexpected end of file.
 @G_ERR_UNEXP_EOF_IN_STRING: unterminated string constant.
 @G_ERR_UNEXP_EOF_IN_COMMENT: unterminated comment.
 @G_ERR_NON_DIGIT_IN_CONST: non-digit character in a number.
index 6a519f4..13478ac 100644 (file)
@@ -19,7 +19,7 @@ Shell-related Utilities
 Error codes returned by shell functions.
 </para>
 
-@G_SHELL_ERROR_BAD_QUOTING: Mismatched or otherwise mangled quoting. 
+@G_SHELL_ERROR_BAD_QUOTING: Mismatched or otherwise mangled quoting.
 @G_SHELL_ERROR_EMPTY_STRING: String to be parsed was empty.
 @G_SHELL_ERROR_FAILED: Some other error.
 
index 31a7fb5..07e7dd6 100644 (file)
@@ -22,23 +22,23 @@ Error codes returned by spawning processes.
 @G_SPAWN_ERROR_FORK: Fork failed due to lack of memory.
 @G_SPAWN_ERROR_READ: Read or select on pipes failed.
 @G_SPAWN_ERROR_CHDIR: Changing to working directory failed.
-@G_SPAWN_ERROR_ACCES: <function>execv()</function> returned %EACCES. 
-@G_SPAWN_ERROR_PERM: <function>execv()</function> returned %EPERM. 
-@G_SPAWN_ERROR_2BIG: <function>execv()</function> returned %E2BIG. 
-@G_SPAWN_ERROR_NOEXEC: <function>execv()</function> returned %ENOEXEC. 
+@G_SPAWN_ERROR_ACCES: <function>execv()</function> returned %EACCES.
+@G_SPAWN_ERROR_PERM: <function>execv()</function> returned %EPERM.
+@G_SPAWN_ERROR_2BIG: <function>execv()</function> returned %E2BIG.
+@G_SPAWN_ERROR_NOEXEC: <function>execv()</function> returned %ENOEXEC.
 @G_SPAWN_ERROR_NAMETOOLONG: <function>execv()</function> returned %ENAMETOOLONG.
-@G_SPAWN_ERROR_NOENT: <function>execv()</function> returned %ENOENT. 
-@G_SPAWN_ERROR_NOMEM: <function>execv()</function> returned %ENOMEM. 
-@G_SPAWN_ERROR_NOTDIR: <function>execv()</function> returned %ENOTDIR. 
-@G_SPAWN_ERROR_LOOP: <function>execv()</function> returned %ELOOP. 
-@G_SPAWN_ERROR_TXTBUSY: <function>execv()</function> returned %ETXTBUSY. 
-@G_SPAWN_ERROR_IO: <function>execv()</function> returned %EIO. 
-@G_SPAWN_ERROR_NFILE: <function>execv()</function> returned %ENFILE. 
-@G_SPAWN_ERROR_MFILE: <function>execv()</function> returned %EMFILE. 
-@G_SPAWN_ERROR_INVAL: <function>execv()</function> returned %EINVAL. 
-@G_SPAWN_ERROR_ISDIR: <function>execv()</function> returned %EISDIR. 
-@G_SPAWN_ERROR_LIBBAD: <function>execv()</function> returned %ELIBBAD. 
-@G_SPAWN_ERROR_FAILED: Some other fatal failure, <literal>error-&gt;message</literal> should explain. 
+@G_SPAWN_ERROR_NOENT: <function>execv()</function> returned %ENOENT.
+@G_SPAWN_ERROR_NOMEM: <function>execv()</function> returned %ENOMEM.
+@G_SPAWN_ERROR_NOTDIR: <function>execv()</function> returned %ENOTDIR.
+@G_SPAWN_ERROR_LOOP: <function>execv()</function> returned %ELOOP.
+@G_SPAWN_ERROR_TXTBUSY: <function>execv()</function> returned %ETXTBUSY.
+@G_SPAWN_ERROR_IO: <function>execv()</function> returned %EIO.
+@G_SPAWN_ERROR_NFILE: <function>execv()</function> returned %ENFILE.
+@G_SPAWN_ERROR_MFILE: <function>execv()</function> returned %EMFILE.
+@G_SPAWN_ERROR_INVAL: <function>execv()</function> returned %EINVAL.
+@G_SPAWN_ERROR_ISDIR: <function>execv()</function> returned %EISDIR.
+@G_SPAWN_ERROR_LIBBAD: <function>execv()</function> returned %ELIBBAD.
+@G_SPAWN_ERROR_FAILED: Some other fatal failure, <literal>error-&gt;message</literal> should explain.
 
 <!-- ##### MACRO G_SPAWN_ERROR ##### -->
 <para>
index 6ee73ac..6e1aa4f 100644 (file)
@@ -1619,3 +1619,4 @@ you should also free the #GStaticPrivate.
 
 @private_key: a #GStaticPrivate to be freed.
 
+
index e496c6b..d91bf4c 100644 (file)
@@ -46,7 +46,7 @@ Pops a piece of memory off a #GTrashStack.
 </para>
 
 @stack_p: a pointer to a #GTrashStack.
-@Returns: the element at the top of the stack. 
+@Returns: the element at the top of the stack.
 
 
 <!-- ##### FUNCTION g_trash_stack_peek ##### -->
@@ -55,7 +55,7 @@ Returns the element at the top of a #GTrashStack.
 </para>
 
 @stack_p: a pointer to a #GTrashStack.
-@Returns: the element at the top of the stack. 
+@Returns: the element at the top of the stack.
 
 
 <!-- ##### FUNCTION g_trash_stack_height ##### -->
@@ -64,6 +64,6 @@ Returns the height of a #GTrashStack.
 </para>
 
 @stack_p: a pointer to a #GTrashStack.
-@Returns: the height of the stack. 
+@Returns: the height of the stack.
 
 
index fb94e5d..5f36d5c 100644 (file)
@@ -106,7 +106,7 @@ been stored in the pointer with GUINT_TO_POINTER().
 Stuffs a #gsize into a pointer type.
 </para>
 
-@s: #gsize to stuff into the pointer. 
+@s: #gsize to stuff into the pointer.
 
 
 <!-- ##### MACRO GPOINTER_TO_SIZE ##### -->
index bf5b714..6048a3b 100644 (file)
@@ -31,9 +31,8 @@ Unicode Manipulation
 
 </para>
 
-@Returns: 
-<!-- # Unused Parameters # -->
 @charset: 
+@Returns: 
 
 
 <!-- ##### FUNCTION g_unichar_validate ##### -->
index 6103df8..dec9fda 100644 (file)
@@ -23,15 +23,6 @@ macro %MAXPATHLEN, which is the maximum length of a filename
 
 
 
-<!-- ##### MACRO NAME_MAX ##### -->
-<para>
-Provided for UNIX emulation on Windows; equivalent to UNIX macro 
-%NAME_MAX, which is the maximum length of a single path component.
-i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
-</para>
-
-
-
 <!-- ##### TYPEDEF pid_t ##### -->
 <para>
 Provided for UNIX emulation on Windows; process ID type.
@@ -57,36 +48,33 @@ in any UNIX manual.
 @size: 
 
 
-<!-- ##### MACRO opendir ##### -->
+<!-- ##### FUNCTION opendir ##### -->
 <para>
 Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
 in any UNIX manual.
 </para>
 
+@Param1: 
+@Returns: 
 
 
-<!-- ##### MACRO readdir ##### -->
-<para>
-Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
-in any UNIX manual.
-</para>
-
-
-
-<!-- ##### MACRO rewinddir ##### -->
+<!-- ##### FUNCTION rewinddir ##### -->
 <para>
 Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
 in any UNIX manual.
 </para>
 
+@Param1: 
 
 
-<!-- ##### MACRO closedir ##### -->
+<!-- ##### FUNCTION closedir ##### -->
 <para>
 Provided for UNIX emulation on Windows; see documentation for <function>closedir()</function>
 in any UNIX manual.
 </para>
 
+@Param1: 
+@Returns: 
 
 
 <!-- ##### FUNCTION g_win32_error_message ##### -->
index 1a158d3..b70f16f 100644 (file)
@@ -188,6 +188,8 @@ The predefined identifiers of the reserved fundamental types.
 @G_TYPE_UINT:                  Identifier for the built-in type "guint".
 @G_TYPE_LONG:                  Identifier for the built-in type "glong".
 @G_TYPE_ULONG:                         Identifier for the built-in type "gulong".
+@G_TYPE_INT64: 
+@G_TYPE_UINT64: 
 @G_TYPE_ENUM:                  Identifier for the "#GEnum" type.
 @G_TYPE_FLAGS:                         Identifier for the "#GFlags" type.
 @G_TYPE_FLOAT:                         Identifier for the built-in type "gfloat".
@@ -223,6 +225,8 @@ The predefined identifiers of the reserved fundamental types.
 @G_TYPE_PARAM_VALUE_ARRAY:     Identifier for the "#GParamSpecValueArray" type.
 @G_TYPE_PARAM_CLOSURE:                 Identifier for the "#GParamClosure" type.
 @G_TYPE_PARAM_OBJECT:          Identifier for the "#GParamSpecObject" type.
+@G_TYPE_PARAM_INT64: 
+@G_TYPE_PARAM_UINT64: 
 
 <!-- ##### STRUCT GTypeInterface ##### -->
 <para>