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

Remove all docs from gobject at Tims request. Documentation is only for

Browse Source 
2003-02-07  Matthias Clasen  <maclas@gmx.de>

	* gtypemodule.c:
	* gtype.c:
	* gsourceclosure.c:
	* gparamspecs.c:
	* gparam.c:
	* gobject.c:
	* gsignal.c: Remove all docs from gobject at Tims
	request. Documentation is only for weenies anyway...
This commit is contained in:
Matthias Clasen 2003-02-07 22:04:24 +00:00 committed by Matthias Clasen
parent 7802271bf0
commit fa21b512d5
14 changed files with 77 additions and 927 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ChangeLog
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
ChangeLog.pre-2-10
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
ChangeLog.pre-2-12
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
ChangeLog.pre-2-4
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
ChangeLog.pre-2-6
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
ChangeLog.pre-2-8
View File

@ -1,3 +1,14 @@
2003-02-06 Matthias Clasen <maclas@gmx.de>
* glib/gmessages.h:
* glib/gmem.h:
* glib/ghash.h:
* glib/gasyncqueue.h:
* glib/garray.h:
* glib/ghook.h:
* glib/gtypes.h: Fix a bunch of typos in header comments.
(#102422, Morten Welinder)
2003-02-04 Tor Lillqvist <tml@iki.fi>
* glib/giowin32.c (g_io_channel_unix_new): Fix typo: Should be

11
gobject/ChangeLog
View File

@ -1,3 +1,14 @@
2003-02-07 Matthias Clasen <maclas@gmx.de>
* gtypemodule.c:
* gtype.c:
* gsourceclosure.c:
* gparamspecs.c:
* gparam.c:
* gobject.c:
* gsignal.c: Remove all docs from gobject at Tims
request. Documentation is only for weenies anyway...
2003-01-12 Tor Lillqvist <tml@iki.fi>
* gobject.def: Add g_type_interface_prerequisites. Thanks to

43
gobject/gobject.c
View File

@ -258,14 +258,6 @@ g_object_do_class_init (GObjectClass *class)
1, G_TYPE_PARAM);
}
/**
* g_object_class_install_property:
* @class: a #GObjectClass
* @property_id: the id for the new property
* @pspec: the #GParamSpec for the new property
*
* Installs a new property. This is usually done in the class initializer.
**/
void
g_object_class_install_property (GObjectClass *class,
guint property_id,
@ -475,13 +467,6 @@ g_object_run_dispose (GObject *object)
g_object_unref (object);
}
/**
* g_object_freeze_notify:
* @object: a #GObject
*
* Stops emission of "notify" signals on @object. The signals are
* queued until g_object_thaw_notify() is called on @object.
**/
void
g_object_freeze_notify (GObject *object)
{
@ -494,13 +479,6 @@ g_object_freeze_notify (GObject *object)
g_object_unref (object);
}
/**
* g_object_notify:
* @object: a #GObject
* @property_name: the name of a property installed on the class of @object.
*
* Emits a "notify" signal for the property @property_name on @object.
**/
void
g_object_notify (GObject *object,
const gchar *property_name)
@ -532,14 +510,6 @@ g_object_notify (GObject *object,
g_object_unref (object);
}
/**
* g_object_thaw_notify:
* @object: a #GObject
*
* Reverts the effect of a previous call to g_object_freeze_notify().
* This causes all queued "notify" signals on @object to be emitted.
**/
void
g_object_thaw_notify (GObject *object)
{
@ -1593,19 +1563,6 @@ g_value_dup_object (const GValue *value)
return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
}
/**
* g_signal_connect_object:
* @instance: the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail".
* @c_handler: the #GCallback to connect.
* @gobject: the object to pass as data to @c_handler.
* @connect_flags: a combination of #GConnnectFlags.
*
* This is similar to g_signal_connect_data(), but uses a closure which
* ensures that the object stays alive during the call to @c_handler.
*
* Return value: the handler id.
**/
gulong
g_signal_connect_object (gpointer instance,
const gchar *detailed_signal,

21
gobject/gparam.c
View File

@ -274,27 +274,6 @@ canonicalize_key (gchar *key)
}
}
/**
* g_param_spec_internal:
* @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM
* @name: the canonical name of the property
* @nick: the nickname of the property
* @blurb: a short description of the property
* @flags: a combination of #GParamFlags
*
* Creates a new #GParamSpec instance.
*
* A property name consists of segments consisting of ASCII letters and
* digits, separated by either the '-' or '_' character. The first
* character of a property name must be a letter. Names which violate these
* rules lead to undefined behaviour.
*
* When creating and looking up a #GParamSpec, either separator can be used,
* but they cannot be mixed. Using '-' is considerably more efficient and in
* fact required when using property names as detail strings for signals.
*
* Return value: a newly allocated #GParamSpec instance
**/
gpointer
g_param_spec_internal (GType param_type,
const gchar *name,

226
gobject/gparamspecs.c
View File

@ -1346,22 +1346,6 @@ g_param_spec_types_init (void) /* sync with gtype.c */
/* --- GParamSpec initialization --- */
/**
* g_param_spec_char:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_char (const gchar *name,
const gchar *nick,
@ -1388,22 +1372,6 @@ g_param_spec_char (const gchar *name,
return G_PARAM_SPEC (cspec);
}
/**
* g_param_spec_uchar:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_uchar (const gchar *name,
const gchar *nick,
@ -1430,21 +1398,6 @@ g_param_spec_uchar (const gchar *name,
return G_PARAM_SPEC (uspec);
}
/**
* g_param_spec_boolean:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN
* property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_boolean (const gchar *name,
const gchar *nick,
@ -1467,22 +1420,6 @@ g_param_spec_boolean (const gchar *name,
return G_PARAM_SPEC (bspec);
}
/**
* g_param_spec_int:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_int (const gchar *name,
const gchar *nick,
@ -1509,22 +1446,6 @@ g_param_spec_int (const gchar *name,
return G_PARAM_SPEC (ispec);
}
/**
* g_param_spec_uint:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_uint (const gchar *name,
const gchar *nick,
@ -1551,22 +1472,6 @@ g_param_spec_uint (const gchar *name,
return G_PARAM_SPEC (uspec);
}
/**
* g_param_spec_long:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_long (const gchar *name,
const gchar *nick,
@ -1593,22 +1498,6 @@ g_param_spec_long (const gchar *name,
return G_PARAM_SPEC (lspec);
}
/**
* g_param_spec_ulong:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_ulong (const gchar *name,
const gchar *nick,
@ -1635,22 +1524,6 @@ g_param_spec_ulong (const gchar *name,
return G_PARAM_SPEC (uspec);
}
/**
* g_param_spec_int64:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_int64 (const gchar *name,
const gchar *nick,
@ -1677,23 +1550,6 @@ g_param_spec_int64 (const gchar *name,
return G_PARAM_SPEC (lspec);
}
/**
* g_param_spec_uint64:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64
* property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_uint64 (const gchar *name,
const gchar *nick,
@ -1720,22 +1576,6 @@ g_param_spec_uint64 (const gchar *name,
return G_PARAM_SPEC (uspec);
}
/**
* g_param_spec_unichar:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT
* property. #GValue structures for this property can be accessed with
* g_value_set_uint() and g_value_get_uint().
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_unichar (const gchar *name,
const gchar *nick,
@ -1816,22 +1656,6 @@ g_param_spec_flags (const gchar *name,
return G_PARAM_SPEC (fspec);
}
/**
* g_param_spec_float:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_float (const gchar *name,
const gchar *nick,
@ -1858,23 +1682,6 @@ g_param_spec_float (const gchar *name,
return G_PARAM_SPEC (fspec);
}
/**
* g_param_spec_double:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @minimum: minimum value for the property specified
* @maximum: maximum value for the property specified
* @default_value: default value for the property specified
* @flags: flags for the property specified
*
* Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE
* property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_double (const gchar *name,
const gchar *nick,
@ -1940,21 +1747,6 @@ g_param_spec_param (const gchar *name,
return G_PARAM_SPEC (pspec);
}
/**
* g_param_spec_boxed:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @boxed_type: %G_TYPE_BOXED derived type of this property
* @flags: flags for the property specified
*
* Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED
* derived property.
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_boxed (const gchar *name,
const gchar *nick,
@ -1993,24 +1785,6 @@ g_param_spec_pointer (const gchar *name,
return G_PARAM_SPEC (pspec);
}
/**
* g_param_spec_value_array:
* @name: canonical name of the property specified
* @nick: nick name for the property specified
* @blurb: description of the property specified
* @element_spec: a #GParamSpec describing the elements contained in
* arrays of this property, may be %NULL
* @flags: flags for the property specified
*
* Creates a new #GParamSpecValueArray instance specifying a
* %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED
* type, as such, #GValue structures for this property can be accessed
* with g_value_set_boxed() and g_value_get_boxed().
*
* See g_param_spec_internal() for details on property names.
*
* Return value: a newly created parameter specification
**/
GParamSpec*
g_param_spec_value_array (const gchar *name,
const gchar *nick,

478
gobject/gsignal.c
View File

@ -743,20 +743,6 @@ _g_signals_destroy (GType itype)
SIGNAL_UNLOCK ();
}
/**
* g_signal_stop_emission:
* @instance: the object whose signal handlers you wish to stop.
* @signal_id: the signal identifier, as returned by g_signal_lookup().
* @detail: the detail which the signal was emitted with.
*
* Stops a signal's current emission.
*
* This will prevent the default method from running, if the signal was
* %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
* flag).
*
* Prints a warning if used on a signal which isn't being emitted.
**/
void
g_signal_stop_emission (gpointer instance,
guint signal_id,
@ -812,20 +798,6 @@ signal_finalize_hook (GHookList *hook_list,
}
}
/**
* g_signal_add_emission_hook:
* @signal_id: the signal identifier, as returned by g_signal_lookup().
* @detail: the detail on which to call the hook.
* @hook_func: a #GSignalEmissionHook function.
* @hook_data: user data for @hook_func.
* @data_destroy: a #GDestroyNotify for @hook_data.
*
* Adds an emission hook for a signal, which will get called for any emission
* of that signal, independent of the instance.
*
* Return value: the hook id, for later use with
* g_signal_remove_emission_hook().
**/
gulong
g_signal_add_emission_hook (guint signal_id,
GQuark detail,
@ -875,14 +847,6 @@ g_signal_add_emission_hook (guint signal_id,
return hook->hook_id;
}
/**
* g_signal_remove_emission_hook:
* @signal_id: the id of the signal
* @hook_id: the id of the emission hook, as returned by
* g_signal_add_emission_hook()
*
* Deletes an emission hook.
**/
void
g_signal_remove_emission_hook (guint signal_id,
gulong hook_id)
@ -945,20 +909,6 @@ signal_parse_name (const gchar *name,
return signal_id;
}
/**
* g_signal_parse_name:
* @detailed_signal: a string of the form "signal-name::detail".
* @itype: The interface/instance type that introduced "signal-name".
* @signal_id_p: Location to store the signal id.
* @detail_p: Location to store the detail quark.
* @force_detail_quark: %TRUE forces creation of a #GQuark for the detail.
*
* Internal function to parse a signal name into its @signal_id
* and @detail quark.
*
* Return value: Whether the signal name could successfully be parsed and
* @signal_id_p and @detail_p contain valid return values.
**/
gboolean
g_signal_parse_name (const gchar *detailed_signal,
GType itype,
@ -990,16 +940,6 @@ g_signal_parse_name (const gchar *detailed_signal,
return TRUE;
}
/**
* g_signal_stop_emission_by_name:
* @instance: the object whose signal handlers you wish to stop.
* @detailed_signal: a string of the form "signal-name::detail".
*
* Stops a signal's current emission.
*
* This is just like g_signal_stop_emission() except it will look up the
* signal id for you.
**/
void
g_signal_stop_emission_by_name (gpointer instance,
const gchar *detailed_signal)
@ -1045,21 +985,6 @@ g_signal_stop_emission_by_name (gpointer instance,
SIGNAL_UNLOCK ();
}
/**
* g_signal_lookup:
* @name: the signal's name.
* @itype: the type that the signal operates on.
*
* Given the name of the signal and the type of object it connects to, gets
* the signal's identifying integer. Emitting the signal by number is
* somewhat faster than using the name each time.
*
* Also tries the ancestors of the given type.
*
* See g_signal_new() for details on allowed signal names.
*
* Return value: the signal's identifying number, or 0 if no signal was found.
**/
guint
g_signal_lookup (const gchar *name,
GType itype)
@ -1088,17 +1013,6 @@ g_signal_lookup (const gchar *name,
return signal_id;
}
/**
* g_signal_list_ids:
* @itype: Instance or interface type.
* @n_ids: Location to store the number of signal ids for @itype.
*
* Lists the signals by id that a certain instance or interface type
* created. Further information about the signals can be acquired through
* g_signal_query().
*
* Return value: Newly allocated array of signal IDs.
**/
guint*
g_signal_list_ids (GType itype,
guint *n_ids)
@ -1146,16 +1060,6 @@ g_signal_list_ids (GType itype,
return (guint*) g_array_free (result, FALSE);
}
/**
* g_signal_name:
* @signal_id: the signal's identifying number.
*
* Given the signal's identifier, finds its name.
*
* Two different signals may have the same name, if they have differing types.
*
* Return value: the signal name, or %NULL if the signal number was invalid.
**/
G_CONST_RETURN gchar*
g_signal_name (guint signal_id)
{
@ -1170,19 +1074,6 @@ g_signal_name (guint signal_id)
return name;
}
/**
* g_signal_query:
* @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.
*
* Queries the signal system for in-depth information about a
* specific signal. This function will fill in a user-provided
* structure to hold signal-specific information. If an invalid
* signal id is passed in, the @signal_id member of the #GSignalQuery
* is 0. All members filled into the #GSignalQuery structure should
* be considered constant and have to be left untouched.
**/
void
g_signal_query (guint signal_id,
GSignalQuery *query)
@ -1208,37 +1099,6 @@ g_signal_query (guint signal_id,
SIGNAL_UNLOCK ();
}
/**
* g_signal_new:
* @signal_name: the name for the signal
* @itype: the type this signal pertains to. It will also pertain to
* types which are derived from this type.
* @signal_flags: a combination of #GSignalFlags specifying detail of when
* the default handler is to be invoked. You should at least specify
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_offset: The offset of the function pointer in the class structure
* for this type. Used to invoke a class method generically.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @c_marshaller: the function to translate arrays of parameter values to
* signal emissions into C language callback invocations.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal
* without a return value.
* @n_params: the number of parameter types to follow.
* @Varargs: a list of types, one for each parameter.
*
* Creates a new signal. (This is usually done in the class initializer.)
*
* A signal name consists of segments consisting of ASCII letters and
* digits, separated by either the '-' or '_' character. The first
* character of a signal name must be a letter. Names which violate these
* rules lead to undefined behaviour of the GSignal system.
*
* When registering a signal and looking up a signal, either separator can
* be used, but they cannot be mixed.
*
* Return value: the signal id
**/
guint
g_signal_new (const gchar *signal_name,
GType itype,
@ -1327,30 +1187,6 @@ signal_add_class_closure (SignalNode *node,
g_closure_set_marshal (closure, node->c_marshaller);
}
/**
* g_signal_newv:
* @signal_name: the name for the signal
* @itype: the type this signal pertains to. It will also pertain to
* types which are derived from this type.
* @signal_flags: a combination of #GSignalFlags specifying detail of when
* the default handler is to be invoked. You should at least specify
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_closure: The closure to invoke on signal emission.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @c_marshaller: the function to translate arrays of parameter values to
* signal emissions into C language callback invocations.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal
* without a return value.
* @n_params: the length of @param_types.
* @param_types: an array types, one for each parameter.
*
* Creates a new signal. (This is usually done in the class initializer.)
*
* See g_signal_new() for details on allowed signal names.
*
* Return value: the signal id
**/
guint
g_signal_newv (const gchar *signal_name,
GType itype,
@ -1476,30 +1312,6 @@ g_signal_newv (const gchar *signal_name,
return signal_id;
}
/**
* g_signal_new_valist:
* @signal_name: the name for the signal
* @itype: the type this signal pertains to. It will also pertain to
* types which are derived from this type.
* @signal_flags: a combination of #GSignalFlags specifying detail of when
* the default handler is to be invoked. You should at least specify
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_closure: The closure to invoke on signal emission.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @c_marshaller: the function to translate arrays of parameter values to
* signal emissions into C language callback invocations.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal
* without a return value.
* @n_params: the number of parameter types in @args.
* @args: va_list of #GType, one for each parameter.
*
* Creates a new signal. (This is usually done in the class initializer.)
*
* See g_signal_new() for details on allowed signal names.
*
* Return value: the signal id
**/
guint
g_signal_new_valist (const gchar *signal_name,
GType itype,
@ -1588,17 +1400,6 @@ signal_destroy_R (SignalNode *signal_node)
SIGNAL_LOCK ();
}
/**
* g_signal_override_class_closure:
* @signal_id: the signal id
* @instance_type: the instance type on which to override the class closure
* for the signal.
* @class_closure: the closure.
*
* Overrides the class closure (i.e. the default handler) for the given signal
* for emissions on instances of @instance_type. @instance_type must be derived
* from the type to which the signal belongs.
**/
void
g_signal_override_class_closure (guint signal_id,
GType instance_type,
@ -1625,18 +1426,6 @@ g_signal_override_class_closure (guint signal_id,
SIGNAL_UNLOCK ();
}
/**
* g_signal_chain_from_overridden:
* @instance_and_params: the argument list of the signal emission. The first
* element in the array is a #GValue for the instance the signal is
* being emitted on. The rest are any arguments to be passed to the
* signal.
* @return_value: Location for the return value.
*
* Calls the original class closure of a signal. This function should only
* be called from an overridden class closure; see
* g_signal_override_class_closure().
**/
void
g_signal_chain_from_overridden (const GValue *instance_and_params,
GValue *return_value)
@ -1696,14 +1485,6 @@ g_signal_chain_from_overridden (const GValue *instance_and_params,
SIGNAL_UNLOCK ();
}
/**
* g_signal_get_invocation_hint:
* @instance: the instance to query
*
* Returns the invocation hint of the innermost signal emission of instance.
*
* Return value: the invocation hint of the innermost signal emission.
**/
GSignalInvocationHint*
g_signal_get_invocation_hint (gpointer instance)
{
@ -1718,19 +1499,6 @@ g_signal_get_invocation_hint (gpointer instance)
return emission ? &emission->ihint : NULL;
}
/**
* g_signal_connect_closure_by_id:
* @instance: the instance to connect to.
* @signal_id: the id of the signal.
* @detail: the detail.
* @closure: the closure to connect.
* @after: whether the handler should be called before or after the
* default handler of the signal.
*
* Connects a closure to a signal for a particular object.
*
* Return value: the handler id
**/
gulong
g_signal_connect_closure_by_id (gpointer instance,
guint signal_id,
@ -1773,18 +1541,6 @@ g_signal_connect_closure_by_id (gpointer instance,
return handler_seq_no;
}
/**
* g_signal_connect_closure:
* @instance: the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail".
* @closure: the closure to connect.
* @after: whether the handler should be called before or after the
* default handler of the signal.
*
* Connects a closure to a signal for a particular object.
*
* Return value: the handler id
**/
gulong
g_signal_connect_closure (gpointer instance,
const gchar *detailed_signal,
@ -1831,19 +1587,6 @@ g_signal_connect_closure (gpointer instance,
return handler_seq_no;
}
/**
* g_signal_connect_data:
* @instance: the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail".
* @c_handler: the #GCallback to connect.
* @data: data to pass to @c_handler calls.
* @destroy_data: a #GDestroyNotify for @data.
* @connect_flags: a combination of #GConnectFlags.
*
* Connects a #GCallback function to a signal for a particular object.
*
* Return value: the handler id
**/
gulong
g_signal_connect_data (gpointer instance,
const gchar *detailed_signal,
@ -1896,20 +1639,6 @@ g_signal_connect_data (gpointer instance,
return handler_seq_no;
}
/**
* g_signal_handler_block:
* @instance: The instance to block the signal handler of.
* @handler_id: Handler id of the handler to be blocked.
*
* Blocks a handler of an instance so it will not be called during
* any signal emissions unless it is unblocked again. Thus "blocking"
* a signal handler means to temporarily deactive it, a signal handler
* has to be unblocked exactly the same amount of times it has been
* blocked before to become active again.
*
* The @handler_id has to be a valid signal handler id, connected to a
* signal of @instance.
**/
void
g_signal_handler_block (gpointer instance,
gulong handler_id)
@ -1934,25 +1663,6 @@ g_signal_handler_block (gpointer instance,
SIGNAL_UNLOCK ();
}
/**
* g_signal_handler_unblock:
* @instance: The instance to unblock the signal handler of.
* @handler_id: Handler id of the handler to be unblocked.
*
* Undoes the effect of a previous g_signal_handler_block() call.
* A blocked handler is skipped during signal emissions and will not be
* invoked, unblocking it (for exactly the amount of times it has been
* blocked before) reverts its "blocked" state, so the handler will be
* recognized by the signal system and is called upon future or currently
* ongoing signal emissions (since the order in which handlers are
* called during signal emissions is deterministic, whether the
* unblocked handler in question is called as part of a currently
* ongoing emission depends on how far that emission has proceeded
* yet).
*
* The @handler_id has to be a valid id of a signal handler that is
* connected to a signal of @instance and is currently blocked.
**/
void
g_signal_handler_unblock (gpointer instance,
gulong handler_id)
@ -1976,18 +1686,6 @@ g_signal_handler_unblock (gpointer instance,
SIGNAL_UNLOCK ();
}
/**
* g_signal_handler_disconnect:
* @instance: The instance to remove the signal handler from.
* @handler_id: Handler id of the handler to be disconnected.
*
* Disconnects a handler from an instance so it will not be called during
* any future or currently ongoing emissions of the signal it has been
* connected to. The @handler_id becomes invalid and may be reused.
*
* The @handler_id has to be a valid signal handler id, connected to a
* signal of @instance.
**/
void
g_signal_handler_disconnect (gpointer instance,
gulong handler_id)
@ -2011,16 +1709,6 @@ g_signal_handler_disconnect (gpointer instance,
SIGNAL_UNLOCK ();
}
/**
* g_signal_handler_is_connected:
* @instance: The instance where a signal handler is sought.
* @handler_id: the handler id.
*
* Returns whether @handler_id is the id of a handler connected to @instance.
*
* Return value: whether @handler_id identifies a handler connected to
* @instance.
**/
gboolean
g_signal_handler_is_connected (gpointer instance,
gulong handler_id)
@ -2039,15 +1727,6 @@ g_signal_handler_is_connected (gpointer instance,
return connected;
}
/**
* g_signal_handlers_destroy:
* @instance: The instance whose signal handlers are to be destroyed
*
* Destroys all the signal handlers connected to an object. This is done
* automatically when the object is destroyed.
*
* This function is labeled private.
**/
void
g_signal_handlers_destroy (gpointer instance)
{
@ -2090,25 +1769,6 @@ g_signal_handlers_destroy (gpointer instance)
SIGNAL_UNLOCK ();
}
/**
* g_signal_handler_find:
* @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.
*
* Finds the first signal handler that matches certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType
* flags, and the criteria values are passed as arguments.
* The match @mask has to be non-0 for successful matches.
* If no handler was found, 0 is returned.
*
* Return value: A valid non-0 signal handler id for a successful match.
**/
gulong
g_signal_handler_find (gpointer instance,
GSignalMatchType mask,
@ -2170,27 +1830,6 @@ signal_handlers_foreach_matched_R (gpointer instance,
return n_handlers;
}
/**
* g_signal_handlers_block_matched:
* @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.
*
* Blocks all handlers on an instance that match a certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType
* flags, and the criteria values are passed as arguments.
* Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
* or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
* If no handlers were found, 0 is returned, the number of blocked handlers
* otherwise.
*
* Return value: The amount of handlers that got blocked.
**/
guint
g_signal_handlers_block_matched (gpointer instance,
GSignalMatchType mask,
@ -2217,28 +1856,6 @@ g_signal_handlers_block_matched (gpointer instance,
return n_handlers;
}
/**
* g_signal_handlers_unblock_matched:
* @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.
*
* Unblocks all handlers on an instance that match a certain selection
* criteria. The criteria mask is passed as an OR-ed combination of
* #GSignalMatchType flags, and the criteria values are passed as arguments.
* Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
* or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
* If no handlers were found, 0 is returned, the number of unblocked handlers
* otherwise. The match criteria should not apply to any handlers that are
* not currently blocked.
*
* Return value: The amount of handlers that got unblocked.
**/
guint
g_signal_handlers_unblock_matched (gpointer instance,
GSignalMatchType mask,
@ -2265,27 +1882,6 @@ g_signal_handlers_unblock_matched (gpointer instance,
return n_handlers;
}
/**
* g_signal_handlers_disconnect_matched:
* @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.
*
* Disconnects all handlers on an instance that match a certain selection
* criteria. The criteria mask is passed as an OR-ed combination of
* #GSignalMatchType flags, and the criteria values are passed as arguments.
* Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
* or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
* If no handlers were found, 0 is returned, the number of disconnected
* handlers otherwise.
*
* Return value: The amount of handlers that got disconnected.
**/
guint
g_signal_handlers_disconnect_matched (gpointer instance,
GSignalMatchType mask,
@ -2312,24 +1908,6 @@ g_signal_handlers_disconnect_matched (gpointer instance,
return n_handlers;
}
/**
* g_signal_has_handler_pending:
* @instance: the object whose signal handlers are sought.
* @signal_id: the signal id.
* @detail: the detail.
* @may_be_blocked: whether blocked handlers should count as match.
*
* Returns whether there are any handlers connected to @instance for the
* given signal id and detail.
*
* One example of when you might use this is when the arguments to the
* signal are difficult to compute. A class implementor may opt to not emit
* the signal if no one is attached anyway, thus saving the cost of building
* the arguments.
*
* Return value: %TRUE if a handler is connected to the signal,
* %FALSE otherwise.
**/
gboolean
g_signal_has_handler_pending (gpointer instance,
guint signal_id,
@ -2369,21 +1947,6 @@ g_signal_has_handler_pending (gpointer instance,
return has_pending;
}
/**
* g_signal_emitv:
* @instance_and_params: argument list for the signal emission. The first
* element in the array is a #GValue for the instance the signal is
* being emitted on. The rest are any arguments to be passed to the
* signal.
* @signal_id: the signal id
* @detail: the detail
* @return_value: Location to store the return value of the signal emission.
*
* Emits a signal.
*
* Note that g_signal_emitv() doesn't change @return_value if no handlers are
* connected, in contrast to g_signal_emit() and g_signal_emit_valist().
**/
void
g_signal_emitv (const GValue *instance_and_params,
guint signal_id,
@ -2461,20 +2024,6 @@ g_signal_emitv (const GValue *instance_and_params,
signal_emit_unlocked_R (node, detail, instance, return_value, instance_and_params);
}
/**
* g_signal_emit_valist:
* @instance: the instance the signal is being emitted on.
* @signal_id: the signal id
* @detail: the detail
* @var_args: a list of parameters to be passed to the signal, followed by a
* location for the return value. If the return type of the signal
* is #G_TYPE_NONE, the return value location can be omitted.
*
* Emits a signal.
*
* Note that g_signal_emit_valist() resets the return value to the default
* if no handlers are connected, in contrast to g_signal_emitv().
**/
void
g_signal_emit_valist (gpointer instance,
guint signal_id,
@ -2586,20 +2135,6 @@ g_signal_emit_valist (gpointer instance,
g_free (free_me);
}
/**
* g_signal_emit:
* @instance: the instance the signal is being emitted on.
* @signal_id: the signal id
* @detail: the detail
* @Varargs: parameters to be passed to the signal, followed by a
* location for the return value. If the return type of the signal
* is #G_TYPE_NONE, the return value location can be omitted.
*
* Emits a signal.
*
* Note that g_signal_emit() resets the return value to the default
* if no handlers are connected, in contrast to g_signal_emitv().
**/
void
g_signal_emit (gpointer instance,
guint signal_id,
@ -2613,19 +2148,6 @@ g_signal_emit (gpointer instance,
va_end (var_args);
}
/**
* g_signal_emit_by_name:
* @instance: the instance the signal is being emitted on.
* @detailed_signal: a string of the form "signal-name::detail".
* @Varargs: parameters to be passed to the signal, followed by a
* location for the return value. If the return type of the signal
* is #G_TYPE_NONE, the return value location can be omitted.
*
* Emits a signal.
*
* Note that g_signal_emit_by_name() resets the return value to the default
* if no handlers are connected, in contrast to g_signal_emitv().
**/
void
g_signal_emit_by_name (gpointer instance,
const gchar *detailed_signal,

11
gobject/gsourceclosure.c
View File

@ -154,17 +154,6 @@ static GSourceCallbackFuncs closure_callback_funcs = {
closure_callback_get
};
/**
* g_source_set_closure:
* @source: the source
* @closure: a #GClosure
*
* Set the callback for a source as a #GClosure.
*
* If the source is not one of the standard GLib types, the @closure_callback
* and @closure_marshal fields of the GSourceFuncs structure must have been
* filled in with pointers to appropriate functions.
**/
void
g_source_set_closure (GSource *source,
GClosure *closure)

89
gobject/gtype.c
View File

@ -1146,17 +1146,6 @@ type_iface_add_prerequisite_W (TypeNode *iface,
type_iface_add_prerequisite_W (lookup_type_node_I (dependants[i]), prerequisite_node);
}
/**
* g_type_interface_add_prerequisite:
* @interface_type: #GType value of an interface type.
* @prerequisite_type: #GType value of an interface or instantiatable type.
*
* Adds @prerequisite_type to the list of prerequisites of @interface_type.
* This means that any type implementing @interface_type must also implement
* @prerequisite_type. Prerequisites can be thought of as an alternative to
* interface derivation (which GType doesn't support). An interface can have
* at most one instantiatable prerequisite type.
**/
void
g_type_interface_add_prerequisite (GType interface_type,
GType prerequisite_type)
@ -1232,18 +1221,6 @@ g_type_interface_add_prerequisite (GType interface_type,
}
}
/**
* g_type_interface_prerequisites:
* @interface_type: an interface type
* @n_prerequisites: location to return the number of prerequisites, or %NULL
*
* Returns the prerequisites of an interfaces type.
*
* Return value: a newly-allocated zero-terminated array of #GType containing
* the prerequisites of @interface_type
*
* Since: 2.2
**/
GType* /* free result */
g_type_interface_prerequisites (GType interface_type,
guint *n_prerequisites)
@ -1960,16 +1937,6 @@ g_type_add_interface_static (GType instance_type,
G_WRITE_UNLOCK (&type_rw_lock);
}
/**
* g_type_add_interface_dynamic:
* @instance_type: the #GType value of an instantiable type.
* @interface_type: the #GType value of an interface type.
* @plugin: the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
*
* Adds the dynamic @interface_type to @instantiable_type. The information
* contained in the #GTypePlugin structure pointed to by @plugin
* is used to manage the relationship.
**/
void
g_type_add_interface_dynamic (GType instance_type,
GType interface_type,
@ -2160,19 +2127,6 @@ g_type_interface_peek (gpointer instance_class,
return vtable;
}
/**
* g_type_interface_peek_parent:
* @g_iface: A #GTypeInterface structure.
*
* Returns the corresponding #GTypeInterface structure of the parent type
* of the instance type to which @g_iface belongs. This is useful when
* deriving the implementation of an interface from the parent type and
* then possibly overriding some methods.
*
* Return value: The corresponding #GTypeInterface structure of the parent type
* of the instance type to which @g_iface belongs, or %NULL if the parent type
* doesn't conform to the interface.
**/
gpointer
g_type_interface_peek_parent (gpointer g_iface)
{
@ -2461,16 +2415,6 @@ type_get_qdata_L (TypeNode *node,
return NULL;
}
/**
* g_type_get_qdata:
* @type: a #GType
* @quark: a #GQuark id to identify the data
*
* Obtains data which has previously been attached to @type
* with g_type_set_qdata().
*
* Return value: the data, or %NULL if no data was found
**/
gpointer
g_type_get_qdata (GType type,
GQuark quark)
@ -2528,14 +2472,6 @@ type_set_qdata_W (TypeNode *node,
qdata[i].data = data;
}
/**
* g_type_set_qdata:
* @type: a #GType
* @quark: a #GQuark id to identify the data
* @data: the data
*
* Attaches arbitrary data to a type.
**/
void
g_type_set_qdata (GType type,
GQuark quark,
@ -2572,18 +2508,6 @@ type_add_flags_W (TypeNode *node,
type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
}
/**
* g_type_query:
* @type: the #GType value of a static, classed type.
* @query: A user provided structure that is filled in with constant values
* upon success.
*
* Queries the type system for information about a specific type.
* This function will fill in a user-provided structure to hold type-specific
* information. If an invalid #GType is passed in, the @type member of the
* #GTypeQuery is 0. All members filled into the #GTypeQuery structure should
* be considered constant and have to be left untouched.
**/
void
g_type_query (GType type,
GTypeQuery *query)
@ -2659,19 +2583,6 @@ g_type_get_plugin (GType type)
return node ? node->plugin : NULL;
}
/**
* g_type_interface_get_plugin:
* @instance_type: the #GType value of an instantiatable type.
* @interface_type: the #GType value of an interface type.
*
* Returns the #GTypePlugin structure for the dynamic interface
* @interface_type which has been added to @instance_type, or
* %NULL if @interface_type has not been added to @instance_type or does
* not have a #GTypePlugin structure. See g_type_add_interface_dynamic().
*
* Return value: the #GTypePlugin for the dynamic interface @interface_type
* of @instance_type.
**/
GTypePlugin*
g_type_interface_get_plugin (GType instance_type,
GType interface_type)

59
gobject/gtypemodule.c
View File

@ -130,13 +130,6 @@ g_type_module_get_type (void)
return type_module_type;
}
/**
* g_type_module_set_name
* @module: a #GTypeModule.
* @name: a human-readable name to use in error messages.
*
* Sets the name for a #GTypeModule
**/
void
g_type_module_set_name (GTypeModule *module,
const gchar *name)
@ -183,16 +176,6 @@ g_type_module_find_interface_info (GTypeModule *module,
return NULL;
}
/**
* g_type_module_use:
* @module: a #GTypeModule
*
* Increases the use count of a #GTypeModule by one. If the
* use count was zero before, the plugin will be loaded.
*
* Return Value: %FALSE if the plugin needed to be loaded and
* loading the plugin failed.
**/
gboolean
g_type_module_use (GTypeModule *module)
{
@ -228,16 +211,6 @@ g_type_module_use (GTypeModule *module)
return TRUE;
}
/**
* g_type_module_unuse:
* @module: a #GTypeModule
*
* Decreases the use count of a #GTypeModule by one. If the
* result is zero, the module will be unloaded. (However, the
* #GTypeModule will not be freed, and types associated with the
* #GTypeModule are not unregistered. Once a #GTypeModule is
* initialized, it must exist forever.)
**/
void
g_type_module_unuse (GTypeModule *module)
{
@ -303,24 +276,6 @@ g_type_module_complete_interface_info (GTypePlugin *plugin,
*info = module_interface_info->info;
}
/**
* g_type_module_register_type:
* @module: a #GTypeModule
* @parent_type: the type for the parent class
* @type_name: name for the type
* @type_info: type information structure
* @flags: flags field providing details about the type
*
* Looks up or registers a type that is implemented with a particular
* type plugin. If a type with name @type_name is already registered,
* the #GType identifier for the type is returned, otherwise the type
* is newly registered, and the resulting #GType identifier returned.
*
* As long as any instances of the type exist, the type plugin will
* not be unloaded.
*
* Return value: the type ID for the class.
**/
GType
g_type_module_register_type (GTypeModule *module,
GType parent_type,
@ -381,20 +336,6 @@ g_type_module_register_type (GTypeModule *module,
return module_type_info->type;
}
/**
* g_type_module_add_interface:
* @module: a #GTypeModule
* @instance_type: type to which to add the interface.
* @interface_type: interface type to add
* @interface_info: type information structure
*
* Registers an additional interface for a type, whose interface
* lives in the given type plugin. If the interface was already registered
* for the type in this plugin, nothing will be done.
*
* As long as any instances of the type exist, the type plugin will
* not be unloaded.
**/
void
g_type_module_add_interface (GTypeModule *module,
GType instance_type,