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

*** empty log message ***

Browse Source
This commit is contained in:
Matthias Clasen 2004-12-15 13:55:34 +00:00
parent 1f77f1e80d
commit 80aded0d23
2 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
2004-12-15 Matthias Clasen <mclasen@redhat.com>
* gobject/tmpl/generic_values.sgml: Document some return
values. (#161345, Stefan Kost)
2004-12-02 Matthias Clasen <mclasen@redhat.com> 2004-12-02 Matthias Clasen <mclasen@redhat.com>
* === Released 2.5.7 === * === Released 2.5.7 ===

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

@ -116,9 +116,9 @@ used to pass around pointers to GValueArrays.
Initializes @value with the default value of @type. Initializes @value with the default value of @type.
</para> </para>
@value: A zero-filled (uninitialized) #GValue structure. @value: A zero-filled (uninitialized) #GValue structure.
@g_type: Type the #GValue should hold values of. @g_type: Type the #GValue should hold values of.
@Returns: @Returns: the #GValue structure that has been passed in
<!-- ##### FUNCTION g_value_copy ##### --> <!-- ##### FUNCTION g_value_copy ##### -->
@ -126,8 +126,8 @@ Initializes @value with the default value of @type.
Copies the value of @src_value into @dest_value. Copies the value of @src_value into @dest_value.
</para> </para>
@src_value: An initialized #GValue structure. @src_value: An initialized #GValue structure.
@dest_value: An initialized #GValue structure of the same type as @src_value. @dest_value: An initialized #GValue structure of the same type as @src_value.
<!-- ##### FUNCTION g_value_reset ##### --> <!-- ##### FUNCTION g_value_reset ##### -->
@ -136,8 +136,8 @@ Clears the current value in @value and resets it to the default value
(as if the value had just been initialized). (as if the value had just been initialized).
</para> </para>
@value: An initialized #GValue structure. @value: An initialized #GValue structure.
@Returns: @Returns: the #GValue structure that has been passed in
<!-- ##### FUNCTION g_value_unset ##### --> <!-- ##### FUNCTION g_value_unset ##### -->
@ -148,7 +148,7 @@ An unset value is the same as an uninitialized (zero-filled)
#GValue structure. #GValue structure.
</para> </para>
@value: An initialized #GValue structure. @value: An initialized #GValue structure.
<!-- ##### FUNCTION g_value_fits_pointer ##### --> <!-- ##### FUNCTION g_value_fits_pointer ##### -->
@ -157,8 +157,8 @@ Determines if @value will fit inside the size of a pointer 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_peek_pointer ##### --> <!-- ##### FUNCTION g_value_peek_pointer ##### -->
@ -168,8 +168,8 @@ 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 ##### -->
@ -178,9 +178,9 @@ Returns whether a #GValue of type @src_type can be copied into
a #GValue of type @dest_type. a #GValue of type @dest_type.
</para> </para>
@src_type: source type to be copied. @src_type: source type to be copied.
@dest_type: destination type for copying. @dest_type: destination type for copying.
@Returns: %TRUE if g_value_copy() is possible with @src_type and @dest_type. @Returns: %TRUE if g_value_copy() is possible with @src_type and @dest_type.
<!-- ##### FUNCTION g_value_type_transformable ##### --> <!-- ##### FUNCTION g_value_type_transformable ##### -->
@ -189,9 +189,9 @@ Check whether g_value_transform() is able to transform values
of type @src_type into values of type @dest_type. of type @src_type into values of type @dest_type.
</para> </para>
@src_type: Source type. @src_type: Source type.
@dest_type: Target type. @dest_type: Target type.
@Returns: %TRUE if the transformation is possible, %FALSE otherwise. @Returns: %TRUE if the transformation is possible, %FALSE otherwise.
<!-- ##### FUNCTION g_value_transform ##### --> <!-- ##### FUNCTION g_value_transform ##### -->
@ -205,10 +205,10 @@ 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).
</para> </para>
@src_value: Source value. @src_value: Source value.
@dest_value: Target value. @dest_value: Target value.
@Returns: Whether a transformation rule was found and could be applied. @Returns: Whether a transformation rule was found and could be applied.
Upon failing transformations, @dest_value is left untouched. Upon failing transformations, @dest_value is left untouched.
<!-- ##### USER_FUNCTION GValueTransform ##### --> <!-- ##### USER_FUNCTION GValueTransform ##### -->