luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-14 19:55:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Small fixes

Browse Source 
2005-08-05  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tmpl/generic_values.sgml: Small fixes
This commit is contained in:
Matthias Clasen 2005-08-05 20:40:52 +00:00 committed by Matthias Clasen
parent 0273f0e337
commit 776c3a8bd8
2 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ChangeLog
View File

@ -1,3 +1,7 @@
2005-08-05 Matthias Clasen <mclasen@redhat.com>
* gobject/tmpl/generic_values.sgml: Small fixes
2005-08-05 Matthias Clasen <mclasen@redhat.com> 2005-08-05 Matthias Clasen <mclasen@redhat.com>
* === Released 2.7.7 === * === Released 2.7.7 ===

28
docs/reference/gobject/tmpl/generic_values.sgml
View File

@ -23,7 +23,9 @@ provided by this interface.
<para> <para>
The fundamental types which all support #GValue operations and thus The fundamental types which all support #GValue operations and thus
can be used as a type initializer for g_value_init() are defined by can be used as a type initializer for g_value_init() are defined by
a separate interface. See the Standard Values API for details. a separate interface. See the <link
linkend="gobject-Standard-Parameter-and-Value-Types">Standard Values
API</link> for details.
</para> </para>
<!-- ##### SECTION Stability_Level ##### --> <!-- ##### SECTION Stability_Level ##### -->
@ -31,8 +33,8 @@ a separate interface. See the Standard Values API for details.
<!-- ##### MACRO G_VALUE_HOLDS ##### --> <!-- ##### MACRO G_VALUE_HOLDS ##### -->
<para> <para>
Returns #TRUE if @value holds (or contains) a value of @type. Returns %TRUE if @value holds (or contains) a value of @type.
This macro will also check for @value != #NULL and issue a This macro will also check for @value != %NULL and issue a
warning if the check fails. warning if the check fails.
</para> </para>
@ -79,7 +81,7 @@ used as an abstract base type for derived value types.
<!-- ##### MACRO G_IS_VALUE ##### --> <!-- ##### MACRO G_IS_VALUE ##### -->
<para> <para>
Returns #TRUE if @value is a valid and initialized #GValue structure. Returns %TRUE if @value is a valid and initialized #GValue structure.
</para> </para>
@value: A #GValue structure. @value: A #GValue structure.
@ -93,7 +95,7 @@ to functions within a #GTypeValueTable structure, or implementations of
the g_value_*() API. That is, code portions which implement new fundamental the g_value_*() API. That is, code portions which implement new fundamental
types. types.
#GValue users can not make any assumptions about how data is stored #GValue users can not make any assumptions about how data is stored
within the 2 element #GValue.data[] union, and the g_type member should within the 2 element @data union, and the @g_type member should
only be accessed through the G_VALUE_TYPE() macro. only be accessed through the G_VALUE_TYPE() macro.
</para> </para>
@ -161,18 +163,18 @@ This is an internal function introduced mainly for C marshallers.
</para> </para>
@value: An initialized #GValue structure. @value: An initialized #GValue structure.
@Returns: #TRUE if @value will fit inside a pointer value. @Returns: %TRUE if @value will fit inside a pointer value.
<!-- ##### FUNCTION g_value_peek_pointer ##### --> <!-- ##### FUNCTION g_value_peek_pointer ##### -->
<para> <para>
Return the value contents as pointer. This function asserts that Return the value contents as pointer. This function asserts that
g_value_fits_pointer() returned #TRUE for the passed in value. g_value_fits_pointer() returned %TRUE for the passed in value.
This is an internal function introduced mainly for C marshallers. This is an internal function introduced mainly for C marshallers.
</para> </para>
@value: An initialized #GValue structure. @value: An initialized #GValue structure.
@Returns: #TRUE if @value will fit inside a pointer value. @Returns: %TRUE if @value will fit inside a pointer value.
<!-- ##### FUNCTION g_value_type_compatible ##### --> <!-- ##### FUNCTION g_value_type_compatible ##### -->
@ -199,10 +201,10 @@ of type @src_type into values of type @dest_type.
<!-- ##### FUNCTION g_value_transform ##### --> <!-- ##### FUNCTION g_value_transform ##### -->
<para> <para>
Tries to cast the contents of @src_value into a type apropriate Tries to cast the contents of @src_value into a type appropriate
to store in @dest_value, e.g. to transform a %G_TYPE_INT value to store in @dest_value, e.g. to transform a %G_TYPE_INT value
into a %G_TYPE_FLOAT value. Performing transformations between into a %G_TYPE_FLOAT value. Performing transformations between
value types might incour precision lossage. Especially value types might incur precision lossage. Especially
transformations into strings might reveal seemingly arbitrary transformations into strings might reveal seemingly arbitrary
results and shouldn't be relied upon for production code (such results and shouldn't be relied upon for production code (such
as rcfile value or object property serialization). as rcfile value or object property serialization).
@ -240,9 +242,9 @@ will be replaced.
<!-- ##### FUNCTION g_strdup_value_contents ##### --> <!-- ##### FUNCTION g_strdup_value_contents ##### -->
<para> <para>
Return a newly allocated string, which describes the contents of a #GValue. Return a newly allocated string, which describes the contents of a #GValue.
The main purpose of this function is to describe #GValue contents for debugging The main purpose of this function is to describe #GValue contents for
output, the way in which the contents are described may change between different debugging output, the way in which the contents are described may change
GLib versions. between different GLib versions.
</para> </para>
@value: #GValue which contents are to be described. @value: #GValue which contents are to be described.