added some function documentations.

Tue Jan  9 03:10:38 2001  Tim Janik  <timj@gtk.org>

        * gobject/tmpl/types.sgml: added some function documentations.

        * gobject/gobject-sections.txt: buncha fixups.
This commit is contained in:
Tim Janik
2001-01-09 02:18:57 +00:00
committed by Tim Janik
parent deb68e1592
commit 05122f2861
13 changed files with 1238 additions and 478 deletions

View File

@@ -1,3 +1,18 @@
<!-- ##### FUNCTION g_source_connect_indirect ##### -->
<para>
</para>
@source:
@callback_data:
@callback_funcs:
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### FUNCTION g_mem_check ##### -->
<para>
Checks if the given memory has already been freed. If it has it outputs
@@ -8,53 +23,7 @@ To use this function you must configure glib with the flag
@mem: the memory to check.
<!-- ##### FUNCTION g_main_remove_poll ##### -->
<para>
Removes a file descriptor from the list being polled.
</para>
@fd: the #GPollFD to remove.
<!-- ##### FUNCTION g_source_connect ##### -->
<para>
</para>
@source:
@func:
@data:
@notify:
<!-- ##### MACRO lseek ##### -->
<para>
</para>
<!-- ##### FUNCTION g_main_loop_destroy ##### -->
<para>
</para>
@loop:
<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
<para>
</para>
@s1:
@s2:
@Returns:
<!-- ##### FUNCTION g_convert_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO write ##### -->
<!-- ##### MACRO pclose ##### -->
<para>
</para>
@@ -76,35 +45,13 @@ the results may be needed.
See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
#G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
<!-- ##### MACRO pclose ##### -->
<!-- ##### MACRO lseek ##### -->
<para>
</para>
<!-- ##### FUNCTION g_source_connect_indirect ##### -->
<para>
</para>
@source:
@callback_data:
@callback_funcs:
<!-- ##### MACRO g_string ##### -->
<para>
Turns the argument into a string literal by using the '#' stringizing operator.
</para>
@x: text to convert to a literal string.
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### MACRO access ##### -->
<!-- ##### MACRO getpid ##### -->
<para>
</para>
@@ -123,13 +70,7 @@ priority are stored in the order in which they were added.
type of source.
@Returns: TRUE if an event source was found and removed.
<!-- ##### MACRO open ##### -->
<para>
</para>
<!-- ##### MACRO getpid ##### -->
<!-- ##### MACRO close ##### -->
<para>
</para>
@@ -155,11 +96,24 @@ type of source.
</para>
<!-- ##### MACRO close ##### -->
<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
<para>
</para>
@s1:
@s2:
@Returns:
<!-- ##### FUNCTION g_source_connect ##### -->
<para>
</para>
@source:
@func:
@data:
@notify:
<!-- ##### MACRO getcwd ##### -->
<para>
@@ -167,12 +121,32 @@ type of source.
</para>
<!-- ##### MACRO read ##### -->
<!-- ##### MACRO write ##### -->
<para>
</para>
<!-- ##### FUNCTION g_main_remove_poll ##### -->
<para>
Removes a file descriptor from the list being polled.
</para>
@fd: the #GPollFD to remove.
<!-- ##### MACRO access ##### -->
<para>
</para>
<!-- ##### MACRO g_string ##### -->
<para>
Turns the argument into a string literal by using the '#' stringizing operator.
</para>
@x: text to convert to a literal string.
<!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
<para>
@@ -180,3 +154,29 @@ type of source.
@Returns:
<!-- ##### MACRO read ##### -->
<para>
</para>
<!-- ##### FUNCTION g_main_loop_destroy ##### -->
<para>
</para>
@loop:
<!-- ##### FUNCTION g_convert_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO open ##### -->
<para>
</para>

View File

@@ -66,6 +66,7 @@ only one statement is expected by the compiler.
Portable way to copy <type>va_list</type> variables.
</para>
<!-- # Unused Parameters # -->
@ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
@ap2: a <type>va_list</type>.