Commit 85985ce0 authored by Philip Withnall's avatar Philip Withnall

lib: Fix some gtk-doc warnings

This introduces no functional changes.
Signed-off-by: Philip Withnall's avatarPhilip Withnall <withnall@endlessm.com>
parent 8509af8e
......@@ -59,8 +59,6 @@
/**
* GtSignalLogger:
* @log: the logged signal emissions
* @closures: the set of currently connected signal handler closures
*
* An object which allows signal emissions from zero or more #GObjects to be
* logged easily, without needing to write specific callback functions for any
......@@ -70,24 +68,14 @@
*/
struct _GtSignalLogger
{
/* Log of the signal emissions. Head emission was the first emitted. */
GPtrArray *log; /* (element-type GtSignalLoggerEmission) (owned) */
/* Set of currently connected signal handler closures. */
GPtrArray *closures; /* (element-type GtLoggedClosure) (owned) */
};
/**
* GtLoggedClosure:
* @closure: parent #GClosure
* @logger: the #GtSignalLogger this belongs to
* @obj: pointer to the object instance this closure is connected to; no ref is
* held, and the object may be finalised before the closure, so this should
* only be used as an opaque pointer; add a #GWeakRef if the object needs to
* be accessed in future
* @obj_type_name: a copy of `G_OBJECT_TYPE_NAME (obj)` for use when @obj may
* be invalid
* @signal_name: name of the signal this closure is connected to, including
* detail (if applicable)
* @signal_id: ID of the signal connection, or 0 if this closure has been
* disconnected
*
* A closure representing a connection from @logger to the given @signal_name
* on @obj.
......@@ -100,18 +88,25 @@ struct _GtSignalLogger
typedef struct
{
GClosure closure;
GtSignalLogger *logger; /* (not owned) */
/* Pointer to the object instance this closure is connected to; no ref is
* held, and the object may be finalised before the closure, so this should
* only be used as an opaque pointer; add a #GWeakRef if the object needs to
* be accessed in future. */
gpointer obj; /* (not owned) */
/* A copy of `G_OBJECT_TYPE_NAME (obj)` for use when @obj may be invalid. */
gchar *obj_type_name; /* (owned) */
/* Name of the signal this closure is connected to, including detail
* (if applicable). */
gchar *signal_name; /* (owned) */
gulong signal_id; /* 0 when disconnected */
} GtLoggedClosure;
/**
* GtSignalLoggerEmission:
* @closure: the closure this emission was captured by
* @param_values: array of parameter values, not including the object instance
* @n_param_values: number of elements in @param_values
*
* The details of a particular signal emission, including its parameter values.
*
......@@ -121,7 +116,9 @@ typedef struct
*/
struct _GtSignalLoggerEmission
{
/* The closure this emission was captured by. */
GtLoggedClosure *closure; /* (owned) */
/* Array of parameter values, not including the object instance. */
GValue *param_values; /* (array length=n_param_values) */
gsize n_param_values;
};
......@@ -386,7 +383,7 @@ gt_signal_logger_get_n_emissions (GtSignalLogger *self)
}
/**
* gt_signal_logged_pop_emission:
* gt_signal_logger_pop_emission:
* @self: a #GtSignalLogger
* @out_obj: (out) (transfer none) (optional) (not nullable): return location
* for the object instance which emitted the signal
......
......@@ -29,7 +29,7 @@ G_BEGIN_DECLS
typedef struct _GtSignalLoggerEmission GtSignalLoggerEmission;
void gt_signal_logger_emission_free (GtSignalLoggerEmission *self);
void gt_signal_logger_emission_free (GtSignalLoggerEmission *emission);
void gt_signal_logger_emission_get_params (GtSignalLoggerEmission *self,
...);
......@@ -89,7 +89,8 @@ gchar *gt_signal_logger_format_emissions (GtSignalLogger
* Assert that a signal emission can be popped off the log (using
* gt_signal_logger_pop_emission()) and that it is an emission of @signal_name
* on @obj. The parameters from the emission will be returned in the return
* locations given in the varargs, as with gt_signal_logger_get_params().
* locations given in the varargs, as with
* gt_signal_logger_emission_get_params().
*
* If a signal emission can’t be popped, or if it doesn’t match @signal_name and
* @obj, an assertion fails, and some debug output is printed.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment