Commit 5e45a337 authored by Matthias Clasen's avatar Matthias Clasen

Remove references to nonexisting functions

	* glib/gmain.c: Remove references to nonexisting functions
	g_source_set_callback_closure(), g_source_poll(), g_source_add()
	from docs.

	* glib/gdir.c (g_dir_open): Typo fix in docs.

	* glib/gasyncqueue.c (g_async_queue_lock):
	(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
	<link>s in docs.

	* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.

	* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.

	* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.

	* glib/tmpl/conversions.sgml: Add GIConv.

	* glib/tmpl/main.sgml: Fix references to nonexisting functions
	g_main_loop_destroy(), g_source_add(), g_source_connect().

	* glib/glib-sections.txt: Add GIConv, g_str_has_prefix, g_str_has_suffix.

	* glib/tmpl/linked_lists_single.sgml:
	* glib/tmpl/linked_lists_double.sgml: GListAllocator doesn't exist.

	* glib/glib-docs.sgml: Declare hash entity.

	* glib/tmpl/macros.sgml: Escape # in #ifdef to suppress erroneous links.

	* gobject/Makefile.am, gobject/gobject-docs.sgml, gobject/tmpl/*:
	* glib/Makefile.am, glib/glib-docs.sgml, glib/tmpl/*: Produce XML,
	not SGML.
parent 1ce72b05
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/gmain.c: Remove references to nonexisting functions
g_source_set_callback_closure(), g_source_poll(), g_source_add()
from docs.
* glib/gdir.c (g_dir_open): Typo fix in docs.
* glib/gasyncqueue.c (g_async_queue_lock):
(g_async_queue_unref_and_unlock): Fix markup to avoid erroneous
<link>s in docs.
* glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs.
* glib/gtree.c: Replace some occurances of Gtree by GTree in docs.
* glib/gstring.c (g_string_insert_unichar): Typo fix in docs.
2002-05-23 Havoc Pennington <hp@redhat.com>
* glib/gspawn.c (fork_exec_with_pipes): on success, close the
......
2002-05-26 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/conversions.sgml: Add GIConv.
* glib/tmpl/main.sgml: Fix references to nonexisting functions
g_main_loop_destroy(), g_source_add(), g_source_connect().
* glib/glib-sections.txt: Add GIConv, g_str_has_prefix, g_str_has_suffix.
* glib/tmpl/linked_lists_single.sgml:
* glib/tmpl/linked_lists_double.sgml: GListAllocator doesn't exist.
* glib/glib-docs.sgml: Declare hash entity.
* glib/tmpl/macros.sgml: Escape # in #ifdef to suppress erroneous links.
2002-05-25 Matthias Clasen <maclas@gmx.de>
* gobject/Makefile.am, gobject/gobject-docs.sgml, gobject/tmpl/*:
* glib/Makefile.am, glib/glib-docs.sgml, glib/tmpl/*: Produce XML,
not SGML.
2002-05-21 Matthias Clasen <maclas@gmx.de>
* glib/tmpl/markup.sgml: Updates.
......
......@@ -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=
......
<!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 nbsp "&#x00a0;">
<!ENTITY hash "#">
<!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">
......
......@@ -881,6 +881,8 @@ g_stpcpy
g_strstr_len
g_strrstr
g_strrstr_len
g_str_has_prefix
g_str_has_suffix
<SUBSECTION>
g_strlcpy
......@@ -1825,6 +1827,7 @@ g_random_double_range
<FILE>conversions</FILE>
g_convert
g_convert_with_fallback
GIConv
g_convert_with_iconv
G_CONVERT_ERROR
g_iconv_open
......
......@@ -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 &lt; 10000; i++)
g_array_append_val (garray, i);
for (i = 0; i < 10000; i++)
for (i = 0; i &lt; 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);
......
......@@ -30,10 +30,10 @@ To free a #GByteArray, use g_byte_array_free().
gint i;
gbarray = g_byte_array_new (<!-- -->);
for (i = 0; i < 10000; i++)
for (i = 0; i &lt; 10000; i++)
g_byte_array_append (gbarray, (guint8*) "abcd", 4);
for (i = 0; i < 10000; i++)
for (i = 0; i &lt; 10000; i++)
{
g_assert (gbarray->data[4*i] == 'a');
g_assert (gbarray->data[4*i+1] == 'b');
......
......@@ -47,7 +47,7 @@ point to a location where an error can be placed. For example:
gchar *contents;
GError *err = NULL;
contents = g_file_get_contents ("foo.txt", &amp;err);
g_assert ((contents == NULL && err != NULL) || (contents != NULL && err == NULL));
g_assert ((contents == NULL &amp;&amp; err != NULL) || (contents != NULL &amp;&amp; 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 &lt; 0)
{
g_set_error (error,
FOO_ERROR, /* error domain */
......
......@@ -66,6 +66,14 @@ Specifies the type of function passed to g_set_error_handler().
@hook_list:
@hook:
<!-- ##### STRUCT GIConv ##### -->
<para>
The <structname>GIConv</structname> struct wraps an
<function>iconv()</function> conversion descriptor. It contains private data
and should only be accessed using the following functions.
</para>
<!-- ##### ENUM GIOFileMode ##### -->
<para>
......
......@@ -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 &lt;= 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 first.
@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 &lt;= 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 &lt;&lt; G_HOOK_FLAG_USER_SHIFT</literal> is the first bit
which can be used for application-defined flags.
</para>
......
......@@ -25,7 +25,7 @@ of the
or simply pointers to any type of data.
</para>
<para>
List elements are allocated in blocks using a #GListAllocator, which is
List elements are allocated in blocks using a #GAllocator, which is
more efficient than allocating elements individually.
</para>
<para>
......@@ -216,7 +216,7 @@ the first node matching the given data.
<!-- ##### FUNCTION g_list_free ##### -->
<para>
Frees all of the memory used by a #GList.
The freed elements are added to the #GListAllocator free list.
The freed elements are added to the #GAllocator free list.
</para>
<note>
<para>
......@@ -302,7 +302,7 @@ integer if the first value comes after the second.
@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 &lt; @b; zero if @a = @b; positive value
if @a > @b.
......@@ -328,7 +328,7 @@ integer if the first value comes after the second.
@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 &lt; @b; zero if @a = @b; positive value
if @a > @b.
......
......@@ -25,7 +25,7 @@ of the
or simply pointers to any type of data.
</para>
<para>
List elements are allocated in blocks using a #GListAllocator, which is
List elements are allocated in blocks using a #GAllocator, which is
more efficient than allocating elements individually.
</para>
<para>
......@@ -224,7 +224,7 @@ the first node matching the given data.
<!-- ##### FUNCTION g_slist_free ##### -->
<para>
Frees all of the memory used by a #GSList.
The freed elements are added to the #GListAllocator free list.
The freed elements are added to the #GAllocator free list.
</para>
@list: a #GSList.
......
......@@ -38,7 +38,7 @@ The micro version number of the GLib library.
<!-- ##### MACRO G_OS_WIN32 ##### -->
<para>
This macro is defined only on Windows. So you can bracket
Windows-specific code in "#ifdef G_OS_WIN32".
Windows-specific code in "&hash;ifdef G_OS_WIN32".
</para>
......@@ -46,7 +46,7 @@ Windows-specific code in "#ifdef G_OS_WIN32".
<!-- ##### MACRO G_OS_BEOS ##### -->
<para>
This macro is defined only on BeOS. So you can bracket
BeOS-specific code in "#ifdef G_OS_BEOS".
BeOS-specific code in "&hash;ifdef G_OS_BEOS".
</para>
......@@ -54,7 +54,7 @@ BeOS-specific code in "#ifdef G_OS_BEOS".
<!-- ##### MACRO G_OS_UNIX ##### -->
<para>
This macro is defined only on UNIX. So you can bracket
UNIX-specific code in "#ifdef G_OS_UNIX".
UNIX-specific code in "&hash;ifdef G_OS_UNIX".
</para>
......
......@@ -10,7 +10,7 @@ manages all available sources of events.
GLib and GTK+ applications. These events can come from any number of
different types of sources such as file descriptors (plain files,
pipes or sockets) and timeouts. New types of event sources can also
be added using g_source_add().
be added using g_source_attach().
</para>
<para>
To allow multiple independent sets of sources to be handled in
......@@ -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>
......@@ -184,7 +184,7 @@ very important since calling g_main_run() will set this to %TRUE anyway.
<!-- ##### MACRO g_main_destroy ##### -->
<para>
Frees the memory allocated for the #GMainLoop. A compatibility macro, see
g_main_loop_destroy().
g_main_loop_unref().
</para>
@loop: a #GMainLoop.
......@@ -587,8 +587,8 @@ g_main_context_set_poll_func() for full details.
<!-- ##### 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>
......@@ -664,7 +664,7 @@ called, so the source should be checked again here.
Called to dispatch the event source, after it has returned %TRUE in
either its @prepare or its @check function. The @dispatch function is
passed in a callback function and data. The callback function may be
%NULL if the source was never connected using g_source_connect(). The
%NULL if the source was never connected using g_source_attach(). The
@dispatch function should call the callback function with data and
whatever additional parameters are needed for this type of event source.
</entry>
......
......@@ -127,7 +127,7 @@ Allocates @size bytes on the stack; these bytes will be freed when the current
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 pitfalls as <function>alloca()</functio
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>
......
......@@ -68,18 +68,18 @@ To help debug memory chunks, use g_mem_chunk_info() and g_mem_chunk_print().
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 &lt; 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 &lt; 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 &lt; 10000; i++)
{
g_mem_chunk_free (mem_chunk, mem[i]);
}
......
......@@ -104,6 +104,26 @@ The returned string should be freed when no longer needed.
@Returns:
<!-- ##### FUNCTION g_str_has_prefix ##### -->
<para>
</para>
@str:
@prefix:
@Returns:
<!-- ##### FUNCTION g_str_has_suffix ##### -->
<para>
</para>
@str:
@suffix:
@Returns:
<!-- ##### FUNCTION g_strlcpy ##### -->
<para>
Portability wrapper that calls strlcpy() on systems which have it, and emulates
......@@ -562,8 +582,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 &lt; @s2, or a positive
value if @s1 &gt; @s2.
<!-- ##### FUNCTION g_strncasecmp ##### -->
......@@ -595,8 +615,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 &lt; @s2, or a positive
value if @s1 &gt; @s2.
<!-- ##### FUNCTION g_strreverse ##### -->
......
......@@ -73,8 +73,10 @@ you do not have to worry about having enough space to copy the string.
</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 ##### -->
......
......@@ -1022,7 +1022,7 @@ example:
g_static_rw_lock_reader_lock (&amp;rwlock);
if (index < array->len)
if (index &lt; array->len)
retval = g_ptr_array_index (array, index);
g_static_rw_lock_reader_unlock (&amp;rwlock);
......
......@@ -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
......
<!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 nbsp "&#x00a0;">
<!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>
......
......@@ -175,7 +175,7 @@ When closures are newly created, they get an initial reference count
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 *closure)
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.
......
......@@ -235,22 +235,22 @@ to serve as a container for values of a type.
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-&gt;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>