Re: omf, xml
- From: Matthias Clasen <maclas gmx de>
- To: gtk-doc-list gnome org
- Subject: Re: omf, xml
- Date: 13 May 2002 23:45:08 +0200
And here is a patch to glib. Note that the renaming of docbook files
from .sgml to .xml has only been done for generated files. The .sgml
files under source control should be renamed in the repository, and I
think they should be moved in the xml directory, so that all xml files
are in one place.
Index: docs/reference/glib/Makefile.am
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/Makefile.am,v
retrieving revision 1.32
diff -u -b -B -p -r1.32 Makefile.am
--- docs/reference/glib/Makefile.am 21 Feb 2002 23:07:33 -0000 1.32
+++ docs/reference/glib/Makefile.am 11 May 2002 22:34:28 -0000
@@ -13,7 +13,7 @@ DOC_SOURCE_DIR=../../..
SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode
+MKDB_OPTIONS=--sgml-mode --output-format=xml
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=
Index: docs/reference/glib/glib-docs.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/glib-docs.sgml,v
retrieving revision 1.6
diff -u -b -B -p -r1.6 glib-docs.sgml
--- docs/reference/glib/glib-docs.sgml 17 Jan 2002 23:06:12 -0000 1.6
+++ docs/reference/glib/glib-docs.sgml 11 May 2002 22:34:29 -0000
@@ -1,62 +1,64 @@
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity glib-Basic-Types SYSTEM "sgml/types.sgml">
-<!entity glib-Limits-of-Basic-Types SYSTEM "sgml/limits.sgml">
-<!entity glib-Standard-Macros SYSTEM "sgml/macros.sgml">
-<!entity glib-Type-Conversion-Macros SYSTEM "sgml/type_conversion.sgml">
-<!entity glib-Byte-Order-Macros SYSTEM "sgml/byte_order.sgml">
-<!entity glib-Numerical-Definitions SYSTEM "sgml/numerical.sgml">
-<!entity glib-Miscellaneous-Macros SYSTEM "sgml/macros_misc.sgml">
-<!entity glib-Memory-Allocation SYSTEM "sgml/memory.sgml">
-<!entity glib-Error-Reporting SYSTEM "sgml/error_reporting.sgml">
-<!entity glib-Warnings-and-Assertions SYSTEM "sgml/warnings.sgml">
-<!entity glib-Message-Logging SYSTEM "sgml/messages.sgml">
-<!entity glib-Pattern-Matching SYSTEM "sgml/patterns.sgml">
-<!entity glib-Timers SYSTEM "sgml/timers.sgml">
-<!entity glib-String-Utility-Functions SYSTEM "sgml/string_utils.sgml">
-<!entity glib-Character-Set-Conversion SYSTEM "sgml/conversions.sgml">
-<!entity glib-Unicode-Manipulation SYSTEM "sgml/unicode.sgml">
-<!entity glib-Random-Numbers SYSTEM "sgml/random_numbers.sgml">
-<!entity glib-Miscellaneous-Utility-Functions SYSTEM "sgml/misc_utils.sgml">
-<!entity glib-Date-and-Time-Functions SYSTEM "sgml/date.sgml">
-<!entity glib-The-Main-Event-Loop SYSTEM "sgml/main.sgml">
-<!entity glib-Threads SYSTEM "sgml/threads.sgml">
-<!entity glib-Thread-Pools SYSTEM "sgml/thread_pools.sgml">
-<!entity glib-Async-Queues SYSTEM "sgml/async_queues.sgml">
-<!entity glib-IO-Channels SYSTEM "sgml/iochannels.sgml">
-<!entity glib-Hook-Functions SYSTEM "sgml/hooks.sgml">
-<!entity glib-Lexical-Scanner SYSTEM "sgml/scanner.sgml">
-<!entity glib-Dynamic-Loading-of-Modules SYSTEM "sgml/modules.sgml">
-<!entity glib-Automatic-String-Completion SYSTEM "sgml/completion.sgml">
-<!entity glib-Windows-Compatability-Functions SYSTEM "sgml/windows.sgml">
-<!entity glib-Memory-Chunks SYSTEM "sgml/memory_chunks.sgml">
-<!entity glib-Doubly-Linked-Lists SYSTEM "sgml/linked_lists_double.sgml">
-<!entity glib-Singly-Linked-Lists SYSTEM "sgml/linked_lists_single.sgml">
-<!entity glib-Double-ended-Queues SYSTEM "sgml/queue.sgml">
-<!entity glib-Trash-Stacks SYSTEM "sgml/trash_stack.sgml">
-<!entity glib-Hash-Tables SYSTEM "sgml/hash_tables.sgml">
-<!entity glib-Strings SYSTEM "sgml/strings.sgml">
-<!entity glib-String-Chunks SYSTEM "sgml/string_chunks.sgml">
-<!entity glib-Arrays SYSTEM "sgml/arrays.sgml">
-<!entity glib-Pointer-Arrays SYSTEM "sgml/arrays_pointer.sgml">
-<!entity glib-Byte-Arrays SYSTEM "sgml/arrays_byte.sgml">
-<!entity glib-Balanced-Binary-Trees SYSTEM "sgml/trees-binary.sgml">
-<!entity glib-N-ary-Trees SYSTEM "sgml/trees-nary.sgml">
-<!entity glib-Quarks SYSTEM "sgml/quarks.sgml">
-<!entity glib-Keyed-Data-Lists SYSTEM "sgml/datalist.sgml">
-<!entity glib-Datasets SYSTEM "sgml/datasets.sgml">
-<!entity glib-Relations-and-Tuples SYSTEM "sgml/relations.sgml">
-<!entity glib-Caches SYSTEM "sgml/caches.sgml">
-<!entity glib-Memory-Allocators SYSTEM "sgml/allocators.sgml">
-<!entity glib-Spawn SYSTEM "sgml/spawn.sgml">
-<!entity glib-Fileutils SYSTEM "sgml/fileutils.sgml">
-<!entity glib-Shell SYSTEM "sgml/shell.sgml">
-<!entity glib-Markup SYSTEM "sgml/markup.sgml">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY glib-Basic-Types SYSTEM "xml/types.xml">
+<!ENTITY glib-Limits-of-Basic-Types SYSTEM "xml/limits.xml">
+<!ENTITY glib-Standard-Macros SYSTEM "xml/macros.xml">
+<!ENTITY glib-Type-Conversion-Macros SYSTEM "xml/type_conversion.xml">
+<!ENTITY glib-Byte-Order-Macros SYSTEM "xml/byte_order.xml">
+<!ENTITY glib-Numerical-Definitions SYSTEM "xml/numerical.xml">
+<!ENTITY glib-Miscellaneous-Macros SYSTEM "xml/macros_misc.xml">
+<!ENTITY glib-Memory-Allocation SYSTEM "xml/memory.xml">
+<!ENTITY glib-Error-Reporting SYSTEM "xml/error_reporting.xml">
+<!ENTITY glib-Warnings-and-Assertions SYSTEM "xml/warnings.xml">
+<!ENTITY glib-Message-Logging SYSTEM "xml/messages.xml">
+<!ENTITY glib-Pattern-Matching SYSTEM "xml/patterns.xml">
+<!ENTITY glib-Timers SYSTEM "xml/timers.xml">
+<!ENTITY glib-String-Utility-Functions SYSTEM "xml/string_utils.xml">
+<!ENTITY glib-Character-Set-Conversion SYSTEM "xml/conversions.xml">
+<!ENTITY glib-Unicode-Manipulation SYSTEM "xml/unicode.xml">
+<!ENTITY glib-Random-Numbers SYSTEM "xml/random_numbers.xml">
+<!ENTITY glib-Miscellaneous-Utility-Functions SYSTEM "xml/misc_utils.xml">
+<!ENTITY glib-Date-and-Time-Functions SYSTEM "xml/date.xml">
+<!ENTITY glib-The-Main-Event-Loop SYSTEM "xml/main.xml">
+<!ENTITY glib-Threads SYSTEM "xml/threads.xml">
+<!ENTITY glib-Thread-Pools SYSTEM "xml/thread_pools.xml">
+<!ENTITY glib-Async-Queues SYSTEM "xml/async_queues.xml">
+<!ENTITY glib-IO-Channels SYSTEM "xml/iochannels.xml">
+<!ENTITY glib-Hook-Functions SYSTEM "xml/hooks.xml">
+<!ENTITY glib-Lexical-Scanner SYSTEM "xml/scanner.xml">
+<!ENTITY glib-Dynamic-Loading-of-Modules SYSTEM "xml/modules.xml">
+<!ENTITY glib-Automatic-String-Completion SYSTEM "xml/completion.xml">
+<!ENTITY glib-Windows-Compatability-Functions SYSTEM "xml/windows.xml">
+<!ENTITY glib-Memory-Chunks SYSTEM "xml/memory_chunks.xml">
+<!ENTITY glib-Doubly-Linked-Lists SYSTEM "xml/linked_lists_double.xml">
+<!ENTITY glib-Singly-Linked-Lists SYSTEM "xml/linked_lists_single.xml">
+<!ENTITY glib-Double-ended-Queues SYSTEM "xml/queue.xml">
+<!ENTITY glib-Trash-Stacks SYSTEM "xml/trash_stack.xml">
+<!ENTITY glib-Hash-Tables SYSTEM "xml/hash_tables.xml">
+<!ENTITY glib-Strings SYSTEM "xml/strings.xml">
+<!ENTITY glib-String-Chunks SYSTEM "xml/string_chunks.xml">
+<!ENTITY glib-Arrays SYSTEM "xml/arrays.xml">
+<!ENTITY glib-Pointer-Arrays SYSTEM "xml/arrays_pointer.xml">
+<!ENTITY glib-Byte-Arrays SYSTEM "xml/arrays_byte.xml">
+<!ENTITY glib-Balanced-Binary-Trees SYSTEM "xml/trees-binary.xml">
+<!ENTITY glib-N-ary-Trees SYSTEM "xml/trees-nary.xml">
+<!ENTITY glib-Quarks SYSTEM "xml/quarks.xml">
+<!ENTITY glib-Keyed-Data-Lists SYSTEM "xml/datalist.xml">
+<!ENTITY glib-Datasets SYSTEM "xml/datasets.xml">
+<!ENTITY glib-Relations-and-Tuples SYSTEM "xml/relations.xml">
+<!ENTITY glib-Caches SYSTEM "xml/caches.xml">
+<!ENTITY glib-Memory-Allocators SYSTEM "xml/allocators.xml">
+<!ENTITY glib-Spawn SYSTEM "xml/spawn.xml">
+<!ENTITY glib-Fileutils SYSTEM "xml/fileutils.xml">
+<!ENTITY glib-Shell SYSTEM "xml/shell.xml">
+<!ENTITY glib-Markup SYSTEM "xml/markup.xml">
-<!entity glib-Compiling SYSTEM "compiling.sgml">
-<!entity glib-Building SYSTEM "building.sgml">
-<!entity glib-Running SYSTEM "running.sgml">
-<!entity glib-Resources SYSTEM "resources.sgml">
-<!entity glib-Changes-2-0 SYSTEM "changes-2.0.sgml">
+<!ENTITY glib-Compiling SYSTEM "compiling.sgml">
+<!ENTITY glib-Building SYSTEM "building.sgml">
+<!ENTITY glib-Running SYSTEM "running.sgml">
+<!ENTITY glib-Resources SYSTEM "resources.sgml">
+<!ENTITY glib-Changes-2-0 SYSTEM "changes-2.0.sgml">
]>
<book id="index">
Index: docs/reference/glib/tmpl/arrays.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/arrays.sgml,v
retrieving revision 1.13
diff -u -b -B -p -r1.13 arrays.sgml
--- docs/reference/glib/tmpl/arrays.sgml 12 Dec 2001 20:32:06 -0000 1.13
+++ docs/reference/glib/tmpl/arrays.sgml 11 May 2002 22:34:29 -0000
@@ -39,10 +39,10 @@ To free an array, use g_array_free().
/* We create a new array to store gint values.
We don't want it zero-terminated or cleared to 0's. */
garray = g_array_new (FALSE, FALSE, sizeof (gint));
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
g_array_append_val (garray, i);
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
if (g_array_index (garray, gint, i) != i)
g_print ("ERROR: got %d instead of %d\n",
g_array_index (garray, gint, i), i);
Index: docs/reference/glib/tmpl/arrays_byte.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/arrays_byte.sgml,v
retrieving revision 1.14
diff -u -b -B -p -r1.14 arrays_byte.sgml
--- docs/reference/glib/tmpl/arrays_byte.sgml 18 Apr 2002 22:03:38 -0000 1.14
+++ docs/reference/glib/tmpl/arrays_byte.sgml 11 May 2002 22:34:30 -0000
@@ -30,10 +30,10 @@ To free a #GByteArray, use g_byte_array_
gint i;
gbarray = g_byte_array_new (<!-- -->);
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
g_byte_array_append (gbarray, (guint8*) "abcd", 4);
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
{
g_assert (gbarray->data[4*i] == 'a');
g_assert (gbarray->data[4*i+1] == 'b');
Index: docs/reference/glib/tmpl/error_reporting.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/error_reporting.sgml,v
retrieving revision 1.9
diff -u -b -B -p -r1.9 error_reporting.sgml
--- docs/reference/glib/tmpl/error_reporting.sgml 18 Apr 2002 22:03:38 -0000 1.9
+++ docs/reference/glib/tmpl/error_reporting.sgml 11 May 2002 22:34:31 -0000
@@ -47,7 +47,7 @@ point to a location where an error can b
gchar *contents;
GError *err = NULL;
contents = g_file_get_contents ("foo.txt", &err);
-g_assert ((contents == NULL && err != NULL) || (contents != NULL && err == NULL));
+g_assert ((contents == NULL && err != NULL) || (contents != NULL && err == NULL));
if (err != NULL)
{
/* Report error to user, and free error */
@@ -110,7 +110,7 @@ foo_open_file (GError **error)
fd = open ("file.txt", O_RDONLY);
- if (fd < 0)
+ if (fd < 0)
{
g_set_error (error,
FOO_ERROR, /* error domain */
Index: docs/reference/glib/tmpl/hooks.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/hooks.sgml,v
retrieving revision 1.13
diff -u -b -B -p -r1.13 hooks.sgml
--- docs/reference/glib/tmpl/hooks.sgml 3 Mar 2002 03:15:09 -0000 1.13
+++ docs/reference/glib/tmpl/hooks.sgml 11 May 2002 22:34:32 -0000
@@ -218,7 +218,7 @@ g_hook_insert_sorted().
@new_hook: the #GHook being inserted.
@sibling: the #GHook to compare with @new_hook.
- Returns: a value <= 0 if @new_hook should be before @sibling.
+ Returns: a value <= 0 if @new_hook should be before @sibling.
<!-- ##### FUNCTION g_hook_compare_ids ##### -->
@@ -229,7 +229,7 @@ if the second id is greater than the fir
@new_hook: a #GHook.
@sibling: a #GHook to compare with @new_hook.
- Returns: a value <= 0 if the id of @sibling is >= the id of @new_hook.
+ Returns: a value <= 0 if the id of @sibling is >= the id of @new_hook.
<!-- ##### FUNCTION g_hook_get ##### -->
@@ -357,7 +357,7 @@ Returns the flags of a hook.
<para>
The position of the first bit which is not reserved for internal
use be the #GHook implementation, i.e.
-<literal>1 << G_HOOK_FLAG_USER_SHIFT</literal> is the first bit
+<literal>1 << G_HOOK_FLAG_USER_SHIFT</literal> is the first bit
which can be used for application-defined flags.
</para>
Index: docs/reference/glib/tmpl/linked_lists_double.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/linked_lists_double.sgml,v
retrieving revision 1.16
diff -u -b -B -p -r1.16 linked_lists_double.sgml
--- docs/reference/glib/tmpl/linked_lists_double.sgml 4 Oct 2001 22:26:23 -0000 1.16
+++ docs/reference/glib/tmpl/linked_lists_double.sgml 11 May 2002 22:34:33 -0000
@@ -302,7 +302,7 @@ integer if the first value comes after t
@a: a value.
@b: a value to compare with.
- Returns: negative value if @a < @b; zero if @a = @b; positive value
+ Returns: negative value if @a < @b; zero if @a = @b; positive value
if @a > @b.
@@ -328,7 +328,7 @@ integer if the first value comes after t
@a: a value.
@b: a value to compare with.
@user_data: user data to pass to comparison function.
- Returns: negative value if @a < @b; zero if @a = @b; positive value
+ Returns: negative value if @a < @b; zero if @a = @b; positive value
if @a > @b.
Index: docs/reference/glib/tmpl/main.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/main.sgml,v
retrieving revision 1.21
diff -u -b -B -p -r1.21 main.sgml
--- docs/reference/glib/tmpl/main.sgml 29 Dec 2001 00:09:15 -0000 1.21
+++ docs/reference/glib/tmpl/main.sgml 11 May 2002 22:34:35 -0000
@@ -89,11 +89,11 @@ manages all available sources of events.
</para>
<para>
The operation of these functions can best be seen in terms
- of a state diagram, as shown in <xref linkend="mainloop-states">.
+ of a state diagram, as shown in <xref linkend="mainloop-states"/>.
</para>
<figure id="mainloop-states">
<title>States of a Main Context</title>
- <graphic fileref="mainloop-states.gif" format="gif"></graphic>
+ <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
</figure>
</refsect2>
@@ -587,8 +587,8 @@ g_main_context_set_poll_func() for full
<!-- ##### STRUCT GPollFD ##### -->
<para>
-<informaltable pgwide=1 frame="none" role="struct">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<informaltable pgwide="1" frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>
<row>
@@ -631,8 +631,8 @@ an event source.
The #GSourceFuncs struct contains a table of functions used to handle
event sources in a generic manner.
-<informaltable pgwide=1 frame="none" role="struct">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
+<informaltable pgwide="1" frame="none" role="struct">
+<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>
<row>
Index: docs/reference/glib/tmpl/memory.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/memory.sgml,v
retrieving revision 1.17
diff -u -b -B -p -r1.17 memory.sgml
--- docs/reference/glib/tmpl/memory.sgml 15 Dec 2001 19:29:20 -0000 1.17
+++ docs/reference/glib/tmpl/memory.sgml 11 May 2002 22:34:36 -0000
@@ -127,7 +127,7 @@ Allocates @size bytes on the stack; thes
stack frame is cleaned up. This macro essentially just wraps the
<function>alloca()</function> function present on most UNIX variants.
Thus it provides the same advantages and pitfalls as <function>alloca()</function>:
-<msgtext><variablelist>
+<variablelist>
<varlistentry><term></term><listitem><para>
+ <function>alloca()</function> is very fast, as on most systems it's implemented by just adjusting
the stack pointer register.
@@ -153,7 +153,7 @@ Thus it provides the same advantages and
will be freed together with the variable sized array upon exit of that scope, and
not upon exit of the enclosing function scope.
</para></listitem></varlistentry>
-</variablelist></msgtext>
+</variablelist>
</para>
Index: docs/reference/glib/tmpl/memory_chunks.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/memory_chunks.sgml,v
retrieving revision 1.7
diff -u -b -B -p -r1.7 memory_chunks.sgml
--- docs/reference/glib/tmpl/memory_chunks.sgml 18 Apr 2002 22:03:38 -0000 1.7
+++ docs/reference/glib/tmpl/memory_chunks.sgml 11 May 2002 22:34:36 -0000
@@ -68,18 +68,18 @@ To help debug memory chunks, use g_mem_c
mem_chunk = g_mem_chunk_new ("test mem chunk", 50, 100, G_ALLOC_AND_FREE);
/* Now allocate 10000 atoms. */
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
{
mem[i] = g_chunk_new (gchar, mem_chunk);
/* Fill in the atom memory with some junk. */
- for (j = 0; j < 50; j++)
+ for (j = 0; j < 50; j++)
mem[i][j] = i * j;
}
/* Now free all of the atoms. Note that since we are going to destroy the
GMemChunk, this wouldn't normally be used. */
- for (i = 0; i < 10000; i++)
+ for (i = 0; i < 10000; i++)
{
g_mem_chunk_free (mem_chunk, mem[i]);
}
Index: docs/reference/glib/tmpl/string_utils.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/string_utils.sgml,v
retrieving revision 1.24
diff -u -b -B -p -r1.24 string_utils.sgml
--- docs/reference/glib/tmpl/string_utils.sgml 11 Mar 2002 21:38:18 -0000 1.24
+++ docs/reference/glib/tmpl/string_utils.sgml 11 May 2002 22:34:38 -0000
@@ -562,8 +562,8 @@ how to replace it.
@s1: a string.
@s2: a string to compare with @s1.
- Returns: 0 if the strings match, a negative value if @s1 < @s2, or a positive
-value if @s1 > @s2.
+ Returns: 0 if the strings match, a negative value if @s1 < @s2, or a positive
+value if @s1 > @s2.
<!-- ##### FUNCTION g_strncasecmp ##### -->
@@ -595,8 +595,8 @@ UTF-8.
@s1: a string.
@s2: a string to compare with @s1.
@n: the maximum number of characters to compare.
- Returns: 0 if the strings match, a negative value if @s1 < @s2, or a positive
-value if @s1 > @s2.
+ Returns: 0 if the strings match, a negative value if @s1 < @s2, or a positive
+value if @s1 > @s2.
<!-- ##### FUNCTION g_strreverse ##### -->
Index: docs/reference/glib/tmpl/strings.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/strings.sgml,v
retrieving revision 1.19
diff -u -b -B -p -r1.19 strings.sgml
--- docs/reference/glib/tmpl/strings.sgml 20 Apr 2002 23:46:02 -0000 1.19
+++ docs/reference/glib/tmpl/strings.sgml 11 May 2002 22:34:39 -0000
@@ -73,8 +73,10 @@ you do not have to worry about having en
</para>
@string: the destination #GString. Its current contents are destroyed.
- val: the string to copy into @string.
+ rval:
@Returns: the destination #GString.
+<!-- # Unused Parameters # -->
+ val: the string to copy into @string.
<!-- ##### MACRO g_string_sprintf ##### -->
Index: docs/reference/glib/tmpl/threads.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/glib/tmpl/threads.sgml,v
retrieving revision 1.31
diff -u -b -B -p -r1.31 threads.sgml
--- docs/reference/glib/tmpl/threads.sgml 1 May 2002 14:39:48 -0000 1.31
+++ docs/reference/glib/tmpl/threads.sgml 11 May 2002 22:34:43 -0000
@@ -1022,7 +1022,7 @@ example:
g_static_rw_lock_reader_lock (&rwlock);
- if (index < array->len)
+ if (index < array->len)
retval = g_ptr_array_index (array, index);
g_static_rw_lock_reader_unlock (&rwlock);
Index: docs/reference/gobject/Makefile.am
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/Makefile.am,v
retrieving revision 1.21
diff -u -b -B -p -r1.21 Makefile.am
--- docs/reference/gobject/Makefile.am 14 Feb 2002 00:46:58 -0000 1.21
+++ docs/reference/gobject/Makefile.am 11 May 2002 22:34:43 -0000
@@ -13,7 +13,7 @@ DOC_SOURCE_DIR=../../../gobject
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=
+MKDB_OPTIONS=--output-format=xml
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
Index: docs/reference/gobject/gobject-docs.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/gobject-docs.sgml,v
retrieving revision 1.11
diff -u -b -B -p -r1.11 gobject-docs.sgml
--- docs/reference/gobject/gobject-docs.sgml 14 Nov 2001 01:08:18 -0000 1.11
+++ docs/reference/gobject/gobject-docs.sgml 11 May 2002 22:34:44 -0000
@@ -1,17 +1,19 @@
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity gobject-GType SYSTEM "sgml/gtype.sgml">
-<!entity gobject-GTypePlugin SYSTEM "sgml/gtypeplugin.sgml">
-<!entity gobject-GTypeModule SYSTEM "sgml/gtypemodule.sgml">
-<!entity gobject-The-Base-Object-Type SYSTEM "sgml/objects.sgml">
-<!entity gobject-Enumeration-and-Flag-Types SYSTEM "sgml/enumerations_flags.sgml">
-<!entity gobject-Boxed-Types SYSTEM "sgml/gboxed.sgml">
-<!entity gobject-Generic-values SYSTEM "sgml/generic_values.sgml">
-<!entity gobject-param-value-types SYSTEM "sgml/param_value_types.sgml">
-<!entity gobject-GParamSpec SYSTEM "sgml/gparamspec.sgml">
-<!entity gobject-Varargs-Value-Collection SYSTEM "sgml/value_collection.sgml">
-<!entity gobject-Signals SYSTEM "sgml/signals.sgml">
-<!entity gobject-Closures SYSTEM "sgml/gclosure.sgml">
-<!entity gobject-Value-Arrays SYSTEM "sgml/value_arrays.sgml">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY gobject-GType SYSTEM "xml/gtype.xml">
+<!ENTITY gobject-GTypePlugin SYSTEM "xml/gtypeplugin.xml">
+<!ENTITY gobject-GTypeModule SYSTEM "xml/gtypemodule.xml">
+<!ENTITY gobject-The-Base-Object-Type SYSTEM "xml/objects.xml">
+<!ENTITY gobject-Enumeration-and-Flag-Types SYSTEM "xml/enumerations_flags.xml">
+<!ENTITY gobject-Boxed-Types SYSTEM "xml/gboxed.xml">
+<!ENTITY gobject-Generic-values SYSTEM "xml/generic_values.xml">
+<!ENTITY gobject-param-value-types SYSTEM "xml/param_value_types.xml">
+<!ENTITY gobject-GParamSpec SYSTEM "xml/gparamspec.xml">
+<!ENTITY gobject-Varargs-Value-Collection SYSTEM "xml/value_collection.xml">
+<!ENTITY gobject-Signals SYSTEM "xml/signals.xml">
+<!ENTITY gobject-Closures SYSTEM "xml/gclosure.xml">
+<!ENTITY gobject-Value-Arrays SYSTEM "xml/value_arrays.xml">
]>
<book id="index">
<bookinfo>
Index: docs/reference/gobject/tmpl/gclosure.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/tmpl/gclosure.sgml,v
retrieving revision 1.5
diff -u -b -B -p -r1.5 gclosure.sgml
--- docs/reference/gobject/tmpl/gclosure.sgml 24 Feb 2002 03:19:42 -0000 1.5
+++ docs/reference/gobject/tmpl/gclosure.sgml 11 May 2002 22:34:44 -0000
@@ -175,7 +175,7 @@ When closures are newly created, they ge
of 1, eventhough no caller has yet invoked g_closure_ref() on the @closure.
Code entities that store closures for notification purposes are supposed
to call this function, for example like this:
-<msgtext><programlisting>
+<informalexample><programlisting>
static GClosure *notify_closure = NULL;
void
foo_notify_set_closure (GClosure *closure)
@@ -189,7 +189,7 @@ foo_notify_set_closure (GClosure *closur
g_closure_sink (notify_closure);
}
}
-</programlisting></msgtext>
+</programlisting></informalexample>
Because g_closure_sink() may decrement the reference count of a closure
(if it hasn't been called on @closure yet) just like g_closure_unref(),
g_closure_ref() should be called prior to this function.
Index: docs/reference/gobject/tmpl/gtype.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/tmpl/gtype.sgml,v
retrieving revision 1.13
diff -u -b -B -p -r1.13 gtype.sgml
--- docs/reference/gobject/tmpl/gtype.sgml 23 Apr 2002 23:18:37 -0000 1.13
+++ docs/reference/gobject/tmpl/gtype.sgml 11 May 2002 22:34:52 -0000
@@ -242,22 +235,22 @@ to serve as a container for values of a
old contents. E.g. for the implementation of a string
value that may never be %NULL, the implementation might
look like:
-<msgtext><programlisting>
+<programlisting>
{
value->data[0].v_pointer = g_strdup ("");
}
-</programlisting></msgtext>
+</programlisting>
@value_free: Free any old contents that might be left in the
data array of the passed in @value. No resources may
remain allocated through the #GValue contents after
this function returns. E.g. for our above string type:
-<msgtext><programlisting>
+<programlisting>
{
/* only free strings without a specific flag for static storage */
if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
g_free (value->data[0].v_pointer);
}
-</programlisting></msgtext>
+</programlisting>
@value_copy: @dest_value is a #GValue with zero-filled data section
and @src_value is a properly setup #GValue of same or
derived type.
@@ -265,24 +258,24 @@ to serve as a container for values of a
@src_value into @dest_value in a way, that even after
@src_value has been freed, the contents of @dest_value
remain valid. String type example:
-<msgtext><programlisting>
+<programlisting>
{
dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer);
}
-</programlisting></msgtext>
+</programlisting>
@value_peek_pointer: If the value contents fit into a pointer, such as objects
or strings, return this pointer, so the caller can peek at
the current contents. To extend on our above string example:
-<msgtext><programlisting>
+<programlisting>
{
return value->data[0].v_pointer;
}
-</programlisting></msgtext>
+</programlisting>
@collect_format: A string format describing how to collect the contents of
this value, bit-by-bit. Each character in the format represents
an argument to be collected, the characters themselves indicate
the type of the argument. Currently supported arguments are:
-<msgtext><variablelist>
+<variablelist>
<varlistentry><term></term><listitem><para>
'i' - Integers. passed as collect_values[].v_int.
</para></listitem></varlistentry>
@@ -295,7 +288,7 @@ to serve as a container for values of a
<varlistentry><term></term><listitem><para>
'p' - Pointers. passed as collect_values[].v_pointer.
</para></listitem></varlistentry>
-</variablelist></msgtext>
+</variablelist>
It should be noted, that for variable argument list construction,
ANSI C promotes every type smaller than an integer to an int, and
floats to doubles. So for collection of short int or char, 'i'
@@ -320,7 +313,7 @@ to serve as a container for values of a
Thus an extra copy of the contents stored in @collect_values is
not required for assignment to @value.
For our above string example, we continue with:
-<msgtext><programlisting>
+<programlisting>
{
if (!collect_values[0].v_pointer)
value->data[0].v_pointer = g_strdup ("");
@@ -335,7 +328,7 @@ to serve as a container for values of a
return NULL;
}
-</programlisting></msgtext>
+</programlisting>
It should be noted, that it is generally a bad idea to follow the
#G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to
reentrancy requirements and reference count assertions performed
@@ -343,7 +336,7 @@ to serve as a container for values of a
for reference counted contents stored in the value->data array.
To deviate from our string example for a moment, and taking a look
at an exemplary implementation for collect_value() of #GObject:
-<msgtext><programlisting>
+<programlisting>
{
if (collect_values[0].v_pointer)
{
@@ -356,7 +349,7 @@ to serve as a container for values of a
else
return g_strdup_printf ("Object passed as invalid NULL pointer");
}
-</programlisting></msgtext>
+</programlisting>
The reference count for valid objects is always incremented,
regardless of @collect_flags. For invalid objects, the example
returns a newly allocated string without altering @value.
@@ -385,7 +378,7 @@ to serve as a container for values of a
Similar to collect_value() the function may prematurely abort
by returning a newly allocated string describing an error condition.
To complete the string example:
-<msgtext><programlisting>
+<programlisting>
{
gchar **string_p = collect_values[0].v_pointer;
@@ -398,10 +391,10 @@ to serve as a container for values of a
*string_p = g_strdup (value->data[0].v_pointer);
}
-</programlisting></msgtext>
+</programlisting>
And an exemplary version of lcopy_value() for
reference-counted types:
-<msgtext><programlisting>
+<programlisting>
{
GObject **object_p = collect_values[0].v_pointer;
@@ -415,7 +408,7 @@ to serve as a container for values of a
*object_p = g_object_ref (value->data[0].v_pointer);
return NULL;
}
-</programlisting></msgtext>
+</programlisting>
<!-- ##### MACRO G_TYPE_FROM_INSTANCE ##### -->
<para>
@@ -682,9 +676,9 @@ a reference count on their parent classe
the returned class will always exist. This function is essentially
equivalent to:
-<msgtext><programlisting>
+<programlisting>
g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)));
-</programlisting></msgtext>
+</programlisting>
</para>
@@ -839,7 +832,7 @@ is performed for class initialization of
An example may help to correspond the intend of the different class
initializers:
-<msgtext><programlisting>
+<programlisting>
typedef struct {
GObjectClass parent_class;
gint static_integer;
@@ -881,7 +874,7 @@ type_b_class_init (TypeBClass *class)
{
class->static_float = 3.14159265358979323846;
}
-</programlisting></msgtext>
+</programlisting>
Initialization of TypeBClass will first cause initialization of
TypeAClass (derived classes reference their parent classes, see
g_type_class_ref() on this).
Index: docs/reference/gobject/tmpl/objects.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/tmpl/objects.sgml,v
retrieving revision 1.13
diff -u -b -B -p -r1.13 objects.sgml
--- docs/reference/gobject/tmpl/objects.sgml 4 Feb 2002 18:08:23 -0000 1.13
+++ docs/reference/gobject/tmpl/objects.sgml 11 May 2002 22:34:53 -0000
@@ -440,7 +440,7 @@ without invoking it's destroy() function
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
-<msgtext><programlisting>
+<programlisting>
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
@@ -464,7 +464,7 @@ free_string_list (gpointer data)
g_free (node->data);
g_list_free (list);
}
-</programlisting></msgtext>
+</programlisting>
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata()
would have left the destroy function set, and thus the partial string list would
have been freed upon g_object_set_qdata_full().
Index: docs/reference/gobject/tmpl/signals.sgml
===================================================================
RCS file: /cvs/gnome/glib/docs/reference/gobject/tmpl/signals.sgml,v
retrieving revision 1.19
diff -u -b -B -p -r1.19 signals.sgml
--- docs/reference/gobject/tmpl/signals.sgml 29 Jan 2002 17:10:33 -0000 1.19
+++ docs/reference/gobject/tmpl/signals.sgml 11 May 2002 22:34:54 -0000
@@ -180,11 +180,11 @@ filled in by the g_signal_query() functi
@n_params: The number of parameters that user callbacks take.
@param_types: The individual parameter types for user callbacks, note that the
effective callback signature is:
-<msgtext><programlisting>
+<programlisting>
@return_type callback (#gpointer data1,
[#param_types param_names,]
#gpointer data2);
-</programlisting></msgtext>
+</programlisting>
<!-- ##### MACRO G_SIGNAL_TYPE_STATIC_SCOPE ##### -->
<para>
Index: glib/giochannel.c
===================================================================
RCS file: /cvs/gnome/glib/glib/giochannel.c,v
retrieving revision 1.35
diff -u -b -B -p -r1.35 giochannel.c
--- glib/giochannel.c 14 Mar 2002 22:38:46 -0000 1.35
+++ glib/giochannel.c 11 May 2002 22:35:08 -0000
@@ -688,7 +688,7 @@ g_io_channel_get_line_term (GIOChannel *
* @flags: the flags to set on the IO channel.
* @error: A location to return an error of type #GIOChannelError.
*
- * Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK).
+ * Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK).
*
* Return value: the status of the operation.
**/
@@ -1696,7 +1696,7 @@ g_io_channel_read_to_end (GIOChannel *ch
* in the buffer if the remaining data is not a
* complete character.
* @bytes_read: The number of bytes read. This may be zero even on
- * success if count < 6 and the channel's encoding is non-%NULL.
+ * success if count < 6 and the channel's encoding is non-%NULL.
* This indicates that the next UTF-8 character is too wide for
* the buffer.
* @error: A location to return an error of type #GConvertError
Index: glib/gutf8.c
===================================================================
RCS file: /cvs/gnome/glib/glib/gutf8.c,v
retrieving revision 1.30
diff -u -b -B -p -r1.30 gutf8.c
--- glib/gutf8.c 24 Jan 2002 14:02:58 -0000 1.30
+++ glib/gutf8.c 11 May 2002 22:35:33 -0000
@@ -716,7 +716,7 @@ g_utf8_get_char_validated (const gchar
/**
* g_utf8_to_ucs4_fast:
* @str: a UTF-8 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is nul-terminated.
* @items_written: location to store the number of characters in the
* result, or %NULL.
@@ -821,7 +821,7 @@ g_utf8_to_ucs4_fast (const gchar *str,
/**
* g_utf8_to_ucs4:
* @str: a UTF-8 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is nul-terminated.
* @items_read: location to store number of bytes read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
@@ -905,7 +905,7 @@ g_utf8_to_ucs4 (const gchar *str,
/**
* g_ucs4_to_utf8:
* @str: a UCS-4 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is terminated with a 0 character.
* @items_read: location to store number of characters read read, or %NULL.
* @items_written: location to store number of bytes written or %NULL.
@@ -978,7 +978,7 @@ g_ucs4_to_utf8 (const gunichar *str,
/**
* g_utf16_to_utf8:
* @str: a UTF-16 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is terminated with a 0 character.
* @items_read: location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
@@ -1122,7 +1122,7 @@ g_utf16_to_utf8 (const gunichar2 *str,
/**
* g_utf16_to_ucs4:
* @str: a UTF-16 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is terminated with a 0 character.
* @items_read: location to store number of words read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
@@ -1264,7 +1264,7 @@ g_utf16_to_ucs4 (const gunichar2 *str,
/**
* g_utf8_to_utf16:
* @str: a UTF-8 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is nul-terminated.
* @items_read: location to store number of bytes read, or %NULL.
* If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
@@ -1381,7 +1381,7 @@ g_utf8_to_utf16 (const gchar *str,
/**
* g_ucs4_to_utf16:
* @str: a UCS-4 encoded string
- * @len: the maximum length of @str to use. If @len < 0, then
+ * @len: the maximum length of @str to use. If @len < 0, then
* the string is terminated with a 0 character.
* @items_read: location to store number of bytes read, or %NULL.
* If an error occurs then the index of the invalid input
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
