luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-01 06:33:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updates added

Browse Source 
Sun Nov  5 13:24:50 2000  Owen Taylor  <otaylor@redhat.com>

	* gobject/Makefile.am gobject/gobject-sections.sgml: Updates
	* gobject/tmpl/g{boxed,type{plugin,module}}.sgml: added
This commit is contained in:
Owen Taylor
2000-11-11 00:03:57 +00:00
committed by Owen Taylor
parent 7d4a8d2c4c
commit 975d1e3e4d
17 changed files with 685 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
docs/reference/glib/tmpl/glib-unused.sgml
View File

@@ -1,70 +1,9 @@
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### MACRO pclose ##### -->
<para>
</para>
<!-- ##### MACRO lseek ##### -->
<para>
</para>
<!-- ##### MACRO getpid ##### -->
<para>
</para>
<!-- ##### MACRO close ##### -->
<para>
</para>
<!-- ##### MACRO fdopen ##### -->
<para>
</para>
<!-- ##### MACRO getcwd ##### -->
<para>
</para>
<!-- ##### MACRO write ##### -->
<para>
</para>
<!-- ##### 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.
<!-- ##### MACRO read ##### -->
<para>
</para>
<!-- ##### FUNCTION g_convert_error_quark ##### -->
<para>
@@ -72,9 +11,70 @@ Turns the argument into a string literal by using the '#' stringizing operator.
@Returns:
<!-- ##### MACRO write ##### -->
<para>
</para>
<!-- ##### MACRO pclose ##### -->
<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.
<!-- ##### MACRO popen ##### -->
<para>
</para>
<!-- ##### MACRO access ##### -->
<para>
</para>
<!-- ##### MACRO open ##### -->
<para>
</para>
<!-- ##### MACRO getpid ##### -->
<para>
</para>
<!-- ##### MACRO fdopen ##### -->
<para>
</para>
<!-- ##### MACRO close ##### -->
<para>
</para>
<!-- ##### MACRO getcwd ##### -->
<para>
</para>
<!-- ##### MACRO read ##### -->
<para>
</para>

36
docs/reference/glib/tmpl/timers.sgml
View File

@@ -2,14 +2,11 @@
Timers
<!-- ##### SECTION Short_Description ##### -->
functions to time operations.
<!-- ##### SECTION Long_Description ##### -->
<para>
Timers can be used to time operations, in a similar way to a stopwatch.
Call g_timer_new () to create the timer, g_timer_start () to start it,
g_timer_elapsed () to determine the time which has elapsed since the timer
was started, and g_timer_stop () to stop the timer.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,32 +16,32 @@ was started, and g_timer_stop () to stop the timer.
<!-- ##### STRUCT GTimer ##### -->
<para>
An opaque data structure which holds the timer information.
</para>
<!-- ##### FUNCTION g_timer_new ##### -->
<para>
Creates a new timer.
</para>
@Returns: the new timer.
@Returns:
<!-- ##### FUNCTION g_timer_start ##### -->
<para>
Starts the timer.
</para>
@timer: the timer.
@timer:
<!-- ##### FUNCTION g_timer_stop ##### -->
<para>
Stops the timer.
</para>
@timer: the timer.
@timer:
<!-- ##### FUNCTION g_timer_elapsed ##### -->
@@ -52,25 +49,24 @@ Stops the timer.
</para>
@timer: the timer.
@microseconds: if non-NULL, this will be set to the microseconds component
of the elapsed time (it does not include the number of seconds elapsed).
@Returns: the elapsed time in seconds, as a double.
@timer:
@microseconds:
@Returns:
<!-- ##### FUNCTION g_timer_reset ##### -->
<para>
Resets the elapsed time to 0, leaving the timer running.
</para>
@timer: the timer.
@timer:
<!-- ##### FUNCTION g_timer_destroy ##### -->
<para>
Destroys the timer, freeing the memory allocated for it.
</para>
@timer: the timer.
@timer:

50
docs/reference/glib/tmpl/type_conversion.sgml
View File

@@ -2,37 +2,11 @@
Type Conversion Macros
<!-- ##### SECTION Short_Description ##### -->
a portable method for storing #gint &amp; #guint values in #gpointer variables.
<!-- ##### SECTION Long_Description ##### -->
<para>
These macros provide a portable method of storing #gint and #guint values in
#gpointer variables.
</para>
<para>
Many of the GLib data types are based on storing #gpointer values,
e.g. #GHashTable, #GList, #GSList, #GTree, and #GNode.
By using the type conversion macros described below you can store #gint and
#guint values inside a #gpointer. So you can, for example, create
a hash table of #gint values, or a linked list of #guint values.
</para>
<para>
The type conversion macros are necessary because the size of a #gpointer can
vary across different platforms. So the type conversion has to be done
carefully.
</para>
<para>
Note that the reverse operation, storing #gpointer values in
integer variables, is not supported, since an integer is not guaranteed to
be large enough to store #gpointer values across all platforms.
</para>
<para>
To convert an integer value, a #gint, to a #gpointer, use #GINT_TO_POINTER.
To convert it back to a #gint, use #GPOINTER_TO_INT.
</para>
<para>
To convert an unsigned integer, a #guint, to a #gpointer, use
#GUINT_TO_POINTER. To convert it back to a #guint, use #GPOINTER_TO_UINT.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -42,37 +16,33 @@ To convert an unsigned integer, a #guint, to a #gpointer, use
<!-- ##### MACRO GINT_TO_POINTER ##### -->
<para>
Converts a #gint to a #gpointer.
</para>
@i: a #gint value.
@Returns: the value converted to a #gpointer.
@i:
<!-- ##### MACRO GPOINTER_TO_INT ##### -->
<para>
Converts a #gpointer to a #gint.
</para>
@p: a #gpointer value.
@Returns: the value converted to a #gint.
@p:
<!-- ##### MACRO GUINT_TO_POINTER ##### -->
<para>
Converts a #guint to a #gpointer.
</para>
@u: a #guint value.
@Returns: the value converted to a #gpointer.
@u:
<!-- ##### MACRO GPOINTER_TO_UINT ##### -->
<para>
Converts a #gpointer to a #guint.
</para>
@p: a #gpointer value.
@Returns: the value converted to a #guint.
@p:

16
docs/reference/glib/tmpl/windows.sgml
View File

@@ -2,23 +2,11 @@
Windows Compatability Functions
<!-- ##### SECTION Short_Description ##### -->
functions to support portability to the Windows environment.
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions and macros are provided in the GLib library when compiled
on the Windows platform.
</para>
<para>
Many of the macros simply rename available windows functions
so that they use the same name as the standard Unix functions.
This means that code written for the Unix platform will work without change
under Windows.
</para>
<para>
A few additional constants, types, and functions are also provided,
to provide a common base set of functions across both the Unix and Windows
environments.
</para>
<!-- ##### SECTION See_Also ##### -->