luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Move some content for gobject-unused.sgml and cleared empty entries. The

Browse Source 
* docs/reference/gobject/tmpl/gobject-unused.sgml:
	* gobject/gobject.h:
	* gobject/gtype.c:
	* gobject/gtype.h:
	  Move some content for gobject-unused.sgml and cleared empty entries.
	  The remaining 4 ones should be checked by some else. If they are not
	  needed. The file can be removed.


svn path=/trunk/; revision=7087
This commit is contained in:
Stefan Kost 2008-06-22 10:10:59 +00:00
parent 43c995df17
commit ac94781e28
5 changed files with 60 additions and 290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
ChangeLog
View File

@ -1,3 +1,13 @@
2008-06-22 Stefan Kost <ensonic@users.sf.net>
* docs/reference/gobject/tmpl/gobject-unused.sgml:
* gobject/gobject.h:
* gobject/gtype.c:
* gobject/gtype.h:
Move some content for gobject-unused.sgml and cleared empty entries.
The remaining 4 ones should be checked by some else. If they are not
needed. The file can be removed.
2008-06-22 Stefan Kost <ensonic@users.sf.net> 2008-06-22 Stefan Kost <ensonic@users.sf.net>
* docs/reference/gobject/tmpl/value_collection.sgml: * docs/reference/gobject/tmpl/value_collection.sgml:

290
docs/reference/gobject/tmpl/gobject-unused.sgml
View File

@ -1,43 +1,3 @@
<!-- ##### SECTION ./tmpl/param_specs.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/param_specs.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/param_specs.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/param_specs.sgml:Title ##### -->
Parameter Specifications
<!-- ##### STRUCT GBoxed ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GBoxedInitFunc ##### -->
<para>
</para>
@Returns:
<!-- ##### STRUCT GParamSpecClosure ##### -->
<para>
</para>
@parent_instance:
<!-- ##### ENUM GTypeFundamentals ##### --> <!-- ##### ENUM GTypeFundamentals ##### -->
<para> <para>
The predefined identifiers of the reserved fundamental types. The predefined identifiers of the reserved fundamental types.
@ -94,172 +54,6 @@ The predefined identifiers of the reserved fundamental types.
@G_TYPE_PARAM_CLOSURE: @G_TYPE_PARAM_CLOSURE:
@G_TYPE_PARAM_OBJECT: @G_TYPE_PARAM_OBJECT:
<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
<para>
Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
pointer. Depending on the current debugging level, this function may invoke
certain runtime checks to identify invalid casts.
</para>
@object: Object which is subject to casting
<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Casts a derived #GInitiallyUnownedClass structure into a
#GInitiallyUnownedClass structure.
</para>
@class: a valid #GInitiallyUnownedClass
<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
<para>
Returns the class structure associated to a #GInitiallyUnowned instance.
</para>
@object: a #GInitiallyUnowned instance
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
<para>
Checks whether a valid #GTypeInstance pointer is of type
%G_TYPE_INITIALLY_UNOWNED.
</para>
@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
<para>
Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
%G_TYPE_INITIALLY_UNOWNED or derived.
</para>
@class: a #GInitiallyUnownedClass
<!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_PARAM_SPEC_CLOSURE ##### -->
<para>
</para>
@pspec:
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
<para>
</para>
<!-- ##### MACRO G_TYPE_FUNDAMENTAL_SHIFT ##### -->
<para>
Shift value used in converting numbers to type IDs.
</para>
<!-- ##### FUNCTION g_closure_add_fnotify ##### -->
<para>
</para>
@closure:
@notify_data:
@notify_func:
<!-- ##### FUNCTION g_closure_add_inotify ##### -->
<para>
</para>
@closure:
@notify_data:
@notify_func:
<!-- ##### FUNCTION g_closure_remove_fnotify ##### -->
<para>
</para>
@closure:
@notify_data:
@notify_func:
<!-- ##### FUNCTION g_closure_remove_inotify ##### -->
<para>
</para>
@closure:
@notify_data:
@notify_func:
<!-- ##### FUNCTION g_param_spec_closure ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@flags:
@Returns:
<!-- ##### FUNCTION g_param_spec_string_c ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@default_value:
@flags:
@Returns:
<!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
<para>
</para>
@signal_id:
@closure:
@Returns:
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para>
</para>
@instance:
<!-- ##### MACRO g_signal_newc ##### -->
<para>
</para>
@Returns:
@signal_name:
@itype:
@signal_flags:
@class_offset:
@accumulator:
@accu_data:
@c_marshaller:
@return_type:
@n_params:
@Varargs:
<!-- ##### FUNCTION g_type_check_class_cast ##### -->
<para>
</para>
@g_class:
@is_a_type:
@Returns:
<!-- ##### FUNCTION g_type_check_flags ##### --> <!-- ##### FUNCTION g_type_check_flags ##### -->
<para> <para>
Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
@ -270,45 +64,6 @@ are set for @type.
@flags: Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags. @flags: Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
@Returns: #TRUE if all @flags are set for @type, #FALSE otherwise. @Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
<!-- ##### FUNCTION g_type_check_instance ##### -->
<para>
Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
macro.
</para>
@instance: A valid #GTypeInstance structure.
@Returns: #TRUE if @instance is valid, #FALSE otherwise.
<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
<para>
</para>
@instance:
@iface_type:
@Returns:
<!-- ##### FUNCTION g_type_check_value ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_type_class_is_a ##### -->
<para>
</para>
@g_class:
@is_a_type:
@Returns:
<!-- ##### FUNCTION g_type_fundamental_last ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_type_instance_is_a ##### --> <!-- ##### FUNCTION g_type_instance_is_a ##### -->
<para> <para>
Determines if @instance adheres to the interface exported Determines if @instance adheres to the interface exported
@ -321,15 +76,6 @@ the anchestry of @instance.
@iface_type: A #GType value. @iface_type: A #GType value.
@Returns: #TRUE if @instance conforms to @iface_type, #FALSE otherwise. @Returns: #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
<!-- ##### FUNCTION g_type_test_flags ##### -->
<para>
</para>
@type:
@flags:
@Returns:
<!-- ##### FUNCTION g_type_value_is_a ##### --> <!-- ##### FUNCTION g_type_value_is_a ##### -->
<para> <para>
Determines if @value is a #GValue whose type conforms to @type. Determines if @value is a #GValue whose type conforms to @type.
@ -339,39 +85,3 @@ Determines if @value is a #GValue whose type conforms to @type.
@type: A #GType value. @type: A #GType value.
@Returns: #TRUE if @value is a #GValue of @type or #FALSE if not. @Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
<!-- ##### FUNCTION g_value_convert ##### -->
<para>
</para>
@src_value:
@dest_value:
@Returns:
<!-- ##### FUNCTION g_value_register_exchange_func ##### -->
<para>
</para>
@value_type1:
@value_type2:
@func:
<!-- ##### FUNCTION g_value_types_exchangable ##### -->
<para>
</para>
@value_type1:
@value_type2:
@Returns:
<!-- ##### FUNCTION g_values_exchange ##### -->
<para>
</para>
@value1:
@value2:
@Returns:

36
gobject/gobject.h
View File

@ -136,10 +136,46 @@ G_BEGIN_DECLS
* The type for #GInitiallyUnowned. * The type for #GInitiallyUnowned.
*/ */
#define G_TYPE_INITIALLY_UNOWNED (g_initially_unowned_get_type()) #define G_TYPE_INITIALLY_UNOWNED (g_initially_unowned_get_type())
/**
* G_INITIALLY_UNOWNED:
* @object: Object which is subject to casting.
*
* Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*)
* pointer. Depending on the current debugging level, this function may invoke
* certain runtime checks to identify invalid casts.
*/
#define G_INITIALLY_UNOWNED(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnowned)) #define G_INITIALLY_UNOWNED(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnowned))
/**
* G_INITIALLY_UNOWNED_CLASS:
* @class: a valid #GInitiallyUnownedClass
*
* Casts a derived #GInitiallyUnownedClass structure into a
* #GInitiallyUnownedClass structure.
*/
#define G_INITIALLY_UNOWNED_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass)) #define G_INITIALLY_UNOWNED_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
/**
* G_IS_INITIALLY_UNOWNED:
* @object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
*
* Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED.
*/
#define G_IS_INITIALLY_UNOWNED(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_INITIALLY_UNOWNED)) #define G_IS_INITIALLY_UNOWNED(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_INITIALLY_UNOWNED))
/**
* G_IS_INITIALLY_UNOWNED_CLASS:
* @class: a #GInitiallyUnownedClass
*
* Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
* %G_TYPE_INITIALLY_UNOWNED or derived.
*/
#define G_IS_INITIALLY_UNOWNED_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_INITIALLY_UNOWNED)) #define G_IS_INITIALLY_UNOWNED_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_INITIALLY_UNOWNED))
/**
* G_INITIALLY_UNOWNED_GET_CLASS:
* @object: a #GInitiallyUnowned instance.
*
* Get the class structure associated to a #GInitiallyUnowned instance.
*
* Returns: pointer to object class structure.
*/
#define G_INITIALLY_UNOWNED_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass)) #define G_INITIALLY_UNOWNED_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
/* GInitiallyUnowned ia a GObject with initially floating reference count */ /* GInitiallyUnowned ia a GObject with initially floating reference count */

9
gobject/gtype.c
View File

@ -3750,6 +3750,15 @@ g_type_check_class_cast (GTypeClass *type_class,
return type_class; return type_class;
} }
/*
* g_type_check_instance:
* @instance: A valid #GTypeInstance structure.
*
* Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
* macro.
*
* @Returns: #TRUE if @instance is valid, #FALSE otherwise.
*/
gboolean gboolean
g_type_check_instance (GTypeInstance *type_instance) g_type_check_instance (GTypeInstance *type_instance)
{ {

5
gobject/gtype.h
View File

@ -185,6 +185,11 @@ G_BEGIN_DECLS
* type IDs with G_TYPE_MAKE_FUNDAMENTAL(). * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
* Send email to gtk-devel-list@gnome.org for reservations. * Send email to gtk-devel-list@gnome.org for reservations.
*/ */
/**
* G_TYPE_FUNDAMENTAL_SHIFT:
*
* Shift value used in converting numbers to type IDs.
*/
#define G_TYPE_FUNDAMENTAL_SHIFT (2) #define G_TYPE_FUNDAMENTAL_SHIFT (2)
/** /**
* G_TYPE_MAKE_FUNDAMENTAL: * G_TYPE_MAKE_FUNDAMENTAL: