From 975d1e3e4db39bbf3ad4451754aa5a83921179af Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Sat, 11 Nov 2000 00:03:57 +0000 Subject: [PATCH] Updates added Sun Nov 5 13:24:50 2000 Owen Taylor * gobject/Makefile.am gobject/gobject-sections.sgml: Updates * gobject/tmpl/g{boxed,type{plugin,module}}.sgml: added --- docs/reference/ChangeLog | 5 + docs/reference/glib/tmpl/glib-unused.sgml | 122 ++++++++--------- docs/reference/glib/tmpl/timers.sgml | 36 +++-- docs/reference/glib/tmpl/type_conversion.sgml | 50 ++----- docs/reference/glib/tmpl/windows.sgml | 16 +-- docs/reference/gobject/Makefile.am | 8 +- docs/reference/gobject/gobject-docs.sgml | 47 ++++--- docs/reference/gobject/gobject-sections.txt | 71 ++++++++-- docs/reference/gobject/tmpl/closures.sgml | 6 + .../gobject/tmpl/enumerations_flags.sgml | 8 ++ docs/reference/gobject/tmpl/gboxed.sgml | 105 +++++++++++++++ .../gobject/tmpl/generic_values.sgml | 18 +++ .../gobject/tmpl/gobject-unused.sgml | 91 +++++++++++-- docs/reference/gobject/tmpl/gtypemodule.sgml | 115 ++++++++++++++++ docs/reference/gobject/tmpl/gtypeplugin.sgml | 98 ++++++++++++++ docs/reference/gobject/tmpl/signals.sgml | 126 +++++++++--------- docs/reference/gobject/tmpl/types.sgml | 65 --------- 17 files changed, 685 insertions(+), 302 deletions(-) create mode 100644 docs/reference/gobject/tmpl/gboxed.sgml create mode 100644 docs/reference/gobject/tmpl/gtypemodule.sgml create mode 100644 docs/reference/gobject/tmpl/gtypeplugin.sgml diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index a31059f30..b13c1ddb6 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Sun Nov 5 13:24:50 2000 Owen Taylor + + * gobject/Makefile.am gobject/gobject-sections.sgml: Updates + * gobject/tmpl/g{boxed,type{plugin,module}}.sgml: added + 2000-11-05 Havoc Pennington * glib/tmpl/markup.sgml: Write docs diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml index 4387d5a83..f954eeede 100644 --- a/docs/reference/glib/tmpl/glib-unused.sgml +++ b/docs/reference/glib/tmpl/glib-unused.sgml @@ -1,70 +1,9 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Turns the argument into a string literal by using the '#' stringizing operator. - - -@x: text to convert to a literal string. - - - - - - - @@ -72,9 +11,70 @@ Turns the argument into a string literal by using the '#' stringizing operator. @Returns: + + + + + + + + + + + + + + +Turns the argument into a string literal by using the '#' stringizing operator. + + +@x: text to convert to a literal string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/glib/tmpl/timers.sgml b/docs/reference/glib/tmpl/timers.sgml index 87cba3791..0a05d6cc8 100644 --- a/docs/reference/glib/tmpl/timers.sgml +++ b/docs/reference/glib/tmpl/timers.sgml @@ -2,14 +2,11 @@ Timers -functions to time operations. + -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. + @@ -19,32 +16,32 @@ was started, and g_timer_stop () to stop the timer. -An opaque data structure which holds the timer information. + -Creates a new timer. + -@Returns: the new timer. +@Returns: -Starts the timer. + -@timer: the timer. +@timer: -Stops the timer. + -@timer: the timer. +@timer: @@ -52,25 +49,24 @@ Stops the timer. -@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: -Resets the elapsed time to 0, leaving the timer running. + -@timer: the timer. +@timer: -Destroys the timer, freeing the memory allocated for it. + -@timer: the timer. +@timer: diff --git a/docs/reference/glib/tmpl/type_conversion.sgml b/docs/reference/glib/tmpl/type_conversion.sgml index 45138be50..dd4adec70 100644 --- a/docs/reference/glib/tmpl/type_conversion.sgml +++ b/docs/reference/glib/tmpl/type_conversion.sgml @@ -2,37 +2,11 @@ Type Conversion Macros -a portable method for storing #gint & #guint values in #gpointer variables. + -These macros provide a portable method of storing #gint and #guint values in -#gpointer variables. - - -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. - - -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. - - -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. - - -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. - - -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. + @@ -42,37 +16,33 @@ To convert an unsigned integer, a #guint, to a #gpointer, use -Converts a #gint to a #gpointer. + -@i: a #gint value. -@Returns: the value converted to a #gpointer. +@i: -Converts a #gpointer to a #gint. + -@p: a #gpointer value. -@Returns: the value converted to a #gint. +@p: -Converts a #guint to a #gpointer. + -@u: a #guint value. -@Returns: the value converted to a #gpointer. +@u: -Converts a #gpointer to a #guint. + -@p: a #gpointer value. -@Returns: the value converted to a #guint. +@p: diff --git a/docs/reference/glib/tmpl/windows.sgml b/docs/reference/glib/tmpl/windows.sgml index e4118b87b..e07c6a839 100644 --- a/docs/reference/glib/tmpl/windows.sgml +++ b/docs/reference/glib/tmpl/windows.sgml @@ -2,23 +2,11 @@ Windows Compatability Functions -functions to support portability to the Windows environment. + -These functions and macros are provided in the GLib library when compiled -on the Windows platform. - - -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. - - -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. + diff --git a/docs/reference/gobject/Makefile.am b/docs/reference/gobject/Makefile.am index b724314a1..855cb567d 100644 --- a/docs/reference/gobject/Makefile.am +++ b/docs/reference/gobject/Makefile.am @@ -13,16 +13,20 @@ DOC_SOURCE_DIR=../../../gobject FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html # Headers to ignore -IGNORE_HFILES= +IGNORE_HFILES= \ + gbsearcharray.h tmpl_sources = \ + tmpl/closures.sgml \ tmpl/enumerations_flags.sgml \ + tmpl/gboxed.sgml \ tmpl/generic_values.sgml \ tmpl/gobject-unused.sgml \ + tmpl/gtypemodule.sgml \ + tmpl/gtypeplugin.sgml \ tmpl/objects.sgml \ tmpl/param_specs.sgml \ tmpl/signals.sgml \ - tmpl/closures.sgml \ tmpl/standard_params.sgml \ tmpl/types.sgml \ tmpl/value_collection.sgml \ diff --git a/docs/reference/gobject/gobject-docs.sgml b/docs/reference/gobject/gobject-docs.sgml index bcec163d0..9e25169ea 100644 --- a/docs/reference/gobject/gobject-docs.sgml +++ b/docs/reference/gobject/gobject-docs.sgml @@ -1,14 +1,17 @@ - - - - - - - - - + + + + + + + + + + + + + ]> @@ -63,16 +66,20 @@ API Reference - &gobject-types; - &gobject-objects; - &gobject-enumerations-flags; - &gobject-generic-values; - &gobject-value-types; - &gobject-value-collection; - &gobject-param-specs; - &gobject-standard-params; - &gobject-signals; - &gobject-closures; + &gobject-GType; + &gobject-GTypePlugin; + &gobject-GTypeModule; + &gobject-The-Base-Object-Type; + &gobject-Enumeration-and-Flag-Types; + &gobject-Boxed-Types; + &gobject-Generic-values; + &gobject-Standard-value-types; + &gobject-Varargs-Value-Collection; + &gobject-Parameter-Specifications; + &gobject-Standard-Parameter-Types; + &gobject-Signals; + &gobject-Closures; + diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 8da78deef..13abe9b7e 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -15,8 +15,6 @@ G_TYPE_IS_INSTANTIATABLE G_TYPE_IS_DERIVABLE G_TYPE_IS_DEEP_DERIVABLE G_TYPE_IS_INTERFACE -GTypePlugin -GTypePluginVTable GTypeInterface GTypeInstance GTypeInfo @@ -57,10 +55,6 @@ GClassFinalizeFunc GInstanceInitFunc GInterfaceInitFunc GInterfaceFinalizeFunc -GTypePluginRef -GTypePluginUnRef -GTypePluginFillTypeInfo -GTypePluginFillInterfaceInfo GTypeClassCacheFunc GTypeFlags g_type_register_static @@ -83,13 +77,52 @@ g_type_get_plugin g_type_fundamental_last g_type_check_instance g_type_check_value -g_type_is_dynamic g_type_value_conforms_to - g_log_domain_gobject +
+gtypeplugin +GTypePlugin +GTypePlugin +GTypePluginUse +GTypePluginUnuse +GTypePluginCompleteTypeInfo +GTypePluginCompleteInterfaceInfo +g_type_plugin_use +g_type_plugin_unuse +g_type_plugin_complete_type_info +g_type_plugin_complete_interface_info + +G_TYPE_PLUGIN +G_IS_TYPE_PLUGIN +G_TYPE_TYPE_PLUGIN +g_type_plugin_get_type +G_TYPE_PLUGIN_CLASS +G_IS_TYPE_PLUGIN_CLASS +G_TYPE_PLUGIN_GET_CLASS +
+ +
+gtypemodule +GTypeModule +GTypeModule +g_type_module_use +g_type_module_unuse +g_type_module_set_name +g_type_module_register_type +g_type_module_add_interface + +G_TYPE_MODULE +G_IS_TYPE_MODULE +G_TYPE_TYPE_MODULE +g_type_module_get_type +G_TYPE_MODULE_CLASS +G_IS_TYPE_MODULE_CLASS +G_TYPE_MODULE_GET_CLASS +
+
The Base Object Type objects @@ -150,6 +183,7 @@ G_FLAGS_CLASS_TYPE G_FLAGS_CLASS_TYPE_NAME G_IS_VALUE_ENUM G_IS_VALUE_FLAGS +G_IS_VALUE_POINTER GEnumValue GFlagsValue g_enum_get_value @@ -168,9 +202,28 @@ g_enum_complete_type_info g_flags_complete_type_info
+
+gboxed +Boxed Types +GBoxed +GBoxedCopyFunc +GBoxedFreeFunc +g_boxed_copy +g_boxed_free +g_value_set_boxed +g_value_set_static_boxed +g_value_get_boxed +g_value_dup_boxed +g_boxed_type_register_static + +G_IS_VALUE_BOXED +G_TYPE_IS_BOXED +
+
Generic values generic_values +G_VALUE_HOLDS G_VALUE_TYPE G_VALUE_TYPE_NAME G_TYPE_IS_VALUE @@ -182,6 +235,7 @@ g_value_copy g_value_convert g_value_reset g_value_unset +g_value_fits_pointer g_values_exchange g_value_types_exchangable g_value_register_exchange_func @@ -360,6 +414,7 @@ GClosureNotify GClosure GCClosure GClosureNotifyData +GCallback G_CLOSURE_NEEDS_MARSHAL G_CCLOSURE_SWAP_DATA g_cclosure_new diff --git a/docs/reference/gobject/tmpl/closures.sgml b/docs/reference/gobject/tmpl/closures.sgml index 9deee480d..8a0435d05 100644 --- a/docs/reference/gobject/tmpl/closures.sgml +++ b/docs/reference/gobject/tmpl/closures.sgml @@ -59,6 +59,12 @@ Closures @data: @notify: + + + + + + diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml index 971195e5d..bc8bb9e91 100644 --- a/docs/reference/gobject/tmpl/enumerations_flags.sgml +++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml @@ -122,6 +122,14 @@ Enumeration and Flag Types @value: + + + + + +@value: + + diff --git a/docs/reference/gobject/tmpl/gboxed.sgml b/docs/reference/gobject/tmpl/gboxed.sgml new file mode 100644 index 000000000..1ffd58fb1 --- /dev/null +++ b/docs/reference/gobject/tmpl/gboxed.sgml @@ -0,0 +1,105 @@ + +gboxed + + + + + + + + + + + + + + + + + + + + + + + + + +@boxed: +@Returns: + + + + + + + +@boxed: + + + + + + + +@boxed_type: +@src_boxed: +@Returns: + + + + + + + +@boxed_type: +@boxed: + + + + + + + +@value: +@boxed: + + + + + + + +@value: +@boxed: + + + + + + + +@value: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@name: +@boxed_copy: +@boxed_free: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml index af4cbe6c2..099dd3f90 100644 --- a/docs/reference/gobject/tmpl/generic_values.sgml +++ b/docs/reference/gobject/tmpl/generic_values.sgml @@ -14,6 +14,15 @@ Generic values + + + + + +@value: +@g_type: + + @@ -105,6 +114,15 @@ Generic values @value: + + + + + +@value: +@Returns: + + diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml index 283510798..0cedc322c 100644 --- a/docs/reference/gobject/tmpl/gobject-unused.sgml +++ b/docs/reference/gobject/tmpl/gobject-unused.sgml @@ -1,14 +1,36 @@ - + -@G_SIGNAL_RUN_FIRST: -@G_SIGNAL_RUN_LAST: -@G_SIGNAL_RUN_CLEANUP: -@G_SIGNAL_NO_RECURSE: -@G_SIGNAL_ACTION: -@G_SIGNAL_NO_HOOKS: + + + + + + +@plugin: + + + + + + +@itype: + + + + + + + + + + +@plugin_ref: +@plugin_unref: +@complete_type_info: +@complete_interface_info: @@ -22,6 +44,41 @@ @after: @Returns: + + + + + +@G_SIGNAL_RUN_FIRST: +@G_SIGNAL_RUN_LAST: +@G_SIGNAL_RUN_CLEANUP: +@G_SIGNAL_NO_RECURSE: +@G_SIGNAL_ACTION: +@G_SIGNAL_NO_HOOKS: + + + + + + +@plugin: +@g_type: +@info: +@value_table: + + + + + + + + + + + + +@plugin: + @@ -29,10 +86,26 @@ @instance: - + -@itype: +@type: +@flags: +@Returns: + + +gtypemodule.sgml + + + + + + + +@plugin: +@interface_type: +@instance_type: +@info: diff --git a/docs/reference/gobject/tmpl/gtypemodule.sgml b/docs/reference/gobject/tmpl/gtypemodule.sgml new file mode 100644 index 000000000..1cbd6586e --- /dev/null +++ b/docs/reference/gobject/tmpl/gtypemodule.sgml @@ -0,0 +1,115 @@ + +GTypeModule + + +Type Loading Modules + + + +#GTypeModule provides a simple implementation of the #GTypePlugin +interface. The model of #GTypeModule is a dynamically loaded module +which implements some number of types and interface +implementations. When the module is loaded, it registerse its types +and interfaces using g_type_module_register_type() and +g_type_module_add_interface(). As long as any instances of these +types and interface implementations are in use, the module is kept +loaded. When the types and interfaces are gone, the module may be +unloaded. If the types and interfaces become used again, the module +will be reloaded. + + +Keeping track of whether the module should be loaded or not is done by +using a use count - it starts at zero, and whenever it is greater than +zero, the module is loaded. The use count is maintained internally by +the type system, but also can be explicitely controlled by +g_type_module_use() and g_type_module_unuse(). Typically, when loading +a module for the first type, g_type_module_use() will be used to load +it so that it can initialize its types. At some later point, when the +module no longer needs to be loaded except for the type +implementations it contains, g_type_module_unuse() is called. + + +#GTypeModule does not actually provide any implementation of module +loading and unloading. To create a particular module type you must +derive from #GTypeModule and implement the load and unload functions +in #GTypeModuleClass. + + + + + + + +#GTypePlugin +The abstract type loader interface. + + + +#GModule +Portable mechanism for dynamically loaded modules. + + + + + + + + + + +@parent_instance: +@use_count: +@type_infos: +@interface_infos: +@name: + + + + + + +@module: +@Returns: + + + + + + + +@module: + + + + + + + +@module: +@name: + + + + + + + +@module: +@parent_type: +@type_name: +@type_info: +@flags: +@Returns: + + + + + + + +@module: +@instance_type: +@interface_type: +@interface_info: + + diff --git a/docs/reference/gobject/tmpl/gtypeplugin.sgml b/docs/reference/gobject/tmpl/gtypeplugin.sgml new file mode 100644 index 000000000..c254eafb5 --- /dev/null +++ b/docs/reference/gobject/tmpl/gtypeplugin.sgml @@ -0,0 +1,98 @@ + +GTypePlugin + + + + + + + + + + + + + + + + + + + + + + + + + +@plugin: + + + + + + + +@plugin: + + + + + + + +@plugin: +@g_type: +@info: +@value_table: + + + + + + + +@plugin: +@interface_type: +@instance_type: +@info: + + + + + + + +@plugin: + + + + + + + +@plugin: + + + + + + + +@plugin: +@g_type: +@info: +@value_table: + + + + + + + +@plugin: +@interface_type: +@instance_type: +@info: + + diff --git a/docs/reference/gobject/tmpl/signals.sgml b/docs/reference/gobject/tmpl/signals.sgml index 3ed1a8d86..83f08a34a 100644 --- a/docs/reference/gobject/tmpl/signals.sgml +++ b/docs/reference/gobject/tmpl/signals.sgml @@ -76,9 +76,9 @@ The @GSignalInvocationHint structure is used to pass on additional information to callbacks during a signal emission. -@signal_id: The signal id of the signal invoking the callback -@detail: The detail passed on for this emission -@run_type: The stage the signal emission is currently in, this +@signal_id: The signal id of the signal invoking the callback +@detail: The detail passed on for this emission +@run_type: The stage the signal emission is currently in, this field will contain one of @G_SIGNAL_RUN_FIRST, @G_SIGNAL_RUN_LAST or @G_SIGNAL_RUN_CLEANUP. @@ -92,11 +92,11 @@ values is perfomed. The return value of signal emissions is then the value returned by the last callback. -@ihint: Signal invokation hint, see @GSignalInvocationHint -@return_accu: Accumulator to collect callback return values in, this +@ihint: Signal invokation hint, see @GSignalInvocationHint +@return_accu: Accumulator to collect callback return values in, this is the return value of the current signal emission -@return_value: The return value of the most recent callback function -@Returns: The accumulator function returns whether the signal emission +@return_value: The return value of the most recent callback function +@Returns: The accumulator function returns whether the signal emission should be aborted. Returning @FALSE means to abort the current emission and @TRUE is returned for continuation. @@ -153,14 +153,14 @@ A structure holding in-depth information for a specific signal. It is filled in by the g_signal_query() function. -@signal_id: The signal id of the signal being querried, or 0 if the +@signal_id: The signal id of the signal being querried, or 0 if the signal to be querried was unknown -@signal_name: The signal name -@itype: The interface/instance type that this signal can be emitted for -@signal_flags: The signal flags as passed in to @g_signal_new() -@return_type: The return type for user callbacks -@n_params: The number of parameters that user callbacks take -@param_types: The individual parameter types for user callbacks, note that the +@signal_name: The signal name +@itype: The interface/instance type that this signal can be emitted for +@signal_flags: The signal flags as passed in to @g_signal_new() +@return_type: The return type for user callbacks +@n_params: The number of parameters that user callbacks take +@param_types: The individual parameter types for user callbacks, note that the effective callback signature is: @return_type callback (@gpointer data1, @@ -225,8 +225,8 @@ is 0. All members filled into the @GSignalQuery structure should be considered constant and have to be left untouched. -@signal_id: The signal id of the signal to query information for -@query: A user provided structure that is filled in with constant +@signal_id: The signal id of the signal to query information for +@query: A user provided structure that is filled in with constant values upon success. @@ -237,9 +237,9 @@ created. Further information about the signals can be aquired through g_signal_query(). -@itype: Instance or interface type -@n_ids: Location to store the number of signal ids for @itype -@Returns: Newly allocated array of signal ids +@itype: Instance or interface type +@n_ids: Location to store the number of signal ids for @itype +@Returns: Newly allocated array of signal ids @@ -268,8 +268,8 @@ to be a valid signal handler id, connected to a signal of @instance. -@instance: The instance to block the signal handler of -@handler_id: Handler id of the handler to be blocked +@instance: The instance to block the signal handler of +@handler_id: Handler id of the handler to be blocked @@ -290,8 +290,8 @@ to be a valid id of a signal handler that is connected to a signal of @instance and is currently blocked. -@instance: The instance to unblock the signal handler of -@handler_id: Handler id of the handler to be unblocked +@instance: The instance to unblock the signal handler of +@handler_id: Handler id of the handler to be unblocked @@ -305,8 +305,8 @@ to be a valid signal handler id, connected to a signal of @instance. -@instance: The instance to remove the signal handler from -@handler_id: Handler id of the handler to be disconnected +@instance: The instance to remove the signal handler from +@handler_id: Handler id of the handler to be disconnected @@ -318,15 +318,15 @@ The match @mask has to be non-0 for successfull matches. If no handler was found, 0 is returned. -@instance: The instance owning the signal handler to be found -@mask: Mask indicating which of @signal_id, @detail, +@instance: The instance owning the signal handler to be found +@mask: Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handler has to match -@signal_id: Signal the handler has to be connected to -@detail: Signal detail the handler has to be connected to -@closure: The closure the handler will invoke -@func: The C closure callback of the handler (useless for non-C closures) -@data: The closure data of the handler's closure -@Returns: A valid non-0 signal handler id for a successfull match +@signal_id: Signal the handler has to be connected to +@detail: Signal detail the handler has to be connected to +@closure: The closure the handler will invoke +@func: The C closure callback of the handler (useless for non-C closures) +@data: The closure data of the handler's closure +@Returns: A valid non-0 signal handler id for a successfull match @@ -340,15 +340,15 @@ If no handlers were found, 0 is returned, the number of blocked handlers otherwise. -@instance: The instance to block handlers from -@mask: Mask indicating which of @signal_id, @detail, +@instance: The instance to block handlers from +@mask: Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match -@signal_id: Signal the handlers have to be connected to -@detail: Signal detail the handlers have to be connected to -@closure: The closure the handlers will invoke -@func: The C closure callback of the handlers (useless for non-C closures) -@data: The closure data of the handlers' closures -@Returns: The amount of handlers that got blocked +@signal_id: Signal the handlers have to be connected to +@detail: Signal detail the handlers have to be connected to +@closure: The closure the handlers will invoke +@func: The C closure callback of the handlers (useless for non-C closures) +@data: The closure data of the handlers' closures +@Returns: The amount of handlers that got blocked @@ -363,15 +363,15 @@ otherwise. The match criteria should not apply to any handlers that are not currently blocked. -@instance: The instance to unblock handlers from -@mask: Mask indicating which of @signal_id, @detail, +@instance: The instance to unblock handlers from +@mask: Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match -@signal_id: Signal the handlers have to be connected to -@detail: Signal detail the handlers have to be connected to -@closure: The closure the handlers will invoke -@func: The C closure callback of the handlers (useless for non-C closures) -@data: The closure data of the handlers' closures -@Returns: The amount of handlers that got unblocked +@signal_id: Signal the handlers have to be connected to +@detail: Signal detail the handlers have to be connected to +@closure: The closure the handlers will invoke +@func: The C closure callback of the handlers (useless for non-C closures) +@data: The closure data of the handlers' closures +@Returns: The amount of handlers that got unblocked @@ -385,15 +385,15 @@ If no handlers were found, 0 is returned, the number of disconnected handlers otherwise. -@instance: The instance to remove handlers from -@mask: Mask indicating which of @signal_id, @detail, +@instance: The instance to remove handlers from +@mask: Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match -@signal_id: Signal the handlers have to be connected to -@detail: Signal detail the handlers have to be connected to -@closure: The closure the handlers will invoke -@func: The C closure callback of the handlers (useless for non-C closures) -@data: The closure data of the handlers' closures -@Returns: The amount of handlers that got disconnected +@signal_id: Signal the handlers have to be connected to +@detail: Signal detail the handlers have to be connected to +@closure: The closure the handlers will invoke +@func: The C closure callback of the handlers (useless for non-C closures) +@data: The closure data of the handlers' closures +@Returns: The amount of handlers that got disconnected @@ -453,12 +453,12 @@ Internal function to parse a signal names into its @signal_id and @detail quark. -@detailed_signal: A string of the form "signal-name::detail" -@itype: The interface/instance type taht introduced "signal-name" -@signal_id_p: Location to store the signal id -@detail_p: Location to stroe the detail quark -@force_detail_quark: %TRUE forces creation of a GQuark for the detail -@Returns: Whether the signal name could successfully be parsed and +@detailed_signal: A string of the form "signal-name::detail" +@itype: The interface/instance type taht introduced "signal-name" +@signal_id_p: Location to store the signal id +@detail_p: Location to stroe the detail quark +@force_detail_quark: %TRUE forces creation of a GQuark for the detail +@Returns: Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. diff --git a/docs/reference/gobject/tmpl/types.sgml b/docs/reference/gobject/tmpl/types.sgml index 6911625fc..69bb59382 100644 --- a/docs/reference/gobject/tmpl/types.sgml +++ b/docs/reference/gobject/tmpl/types.sgml @@ -144,23 +144,6 @@ GType @type: - - - - - -@vtable: - - - - - - -@plugin_ref: -@plugin_unref: -@complete_type_info: -@complete_interface_info: - @@ -519,44 +502,6 @@ GType @iface_data: - - - - - -@plugin: - - - - - - - -@plugin: - - - - - - - -@plugin: -@g_type: -@info: -@value_table: - - - - - - - -@plugin: -@interface_type: -@instance_type: -@info: - - @@ -768,16 +713,6 @@ GType @Returns: - - - - - -@type: -@flags: -@Returns: - -