aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-event.c
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2013-03-03 04:35:31 +0800
committerMatthew Barnes <mbarnes@redhat.com>2013-03-03 08:45:09 +0800
commit7dcd0b44996ade2fc7713a927eb0ff44c5ff9fb2 (patch)
tree1ccda4c2c864e0c0dccccde1811093ecefde1753 /e-util/e-event.c
parent18bdb8b9205e70f725bf49a6f13dc3c2fe3fadf7 (diff)
downloadgsoc2013-evolution-7dcd0b44996ade2fc7713a927eb0ff44c5ff9fb2.tar.gz
gsoc2013-evolution-7dcd0b44996ade2fc7713a927eb0ff44c5ff9fb2.tar.zst
gsoc2013-evolution-7dcd0b44996ade2fc7713a927eb0ff44c5ff9fb2.zip
Update API documentation.
Diffstat (limited to 'e-util/e-event.c')
-rw-r--r--e-util/e-event.c40
1 files changed, 21 insertions, 19 deletions
diff --git a/e-util/e-event.c b/e-util/e-event.c
index c9d046c041..276c55e990 100644
--- a/e-util/e-event.c
+++ b/e-util/e-event.c
@@ -120,18 +120,20 @@ e_event_init (EEvent *event)
/**
* e_event_construct:
- * @ep: An instantiated but uninitialised EEvent.
+ * @event: An instantiated but uninitialised EEvent.
* @id: Event manager id.
*
* Construct the base event instance with standard parameters.
*
- * Return value: Returns @ep.
+ * Returns: the @event
**/
-EEvent *e_event_construct (EEvent *ep, const gchar *id)
+EEvent *
+e_event_construct (EEvent *event,
+ const gchar *id)
{
- ep->id = g_strdup (id);
+ event->id = g_strdup (id);
- return ep;
+ return event;
}
/**
@@ -213,7 +215,7 @@ ee_cmp (gconstpointer ap,
/**
* e_event_emit:
- * @ee: An initialised EEvent, potentially with registered event listeners.
+ * event: An initialised EEvent, potentially with registered event listeners.
* @id: Event name. This will be compared against EEventItem.id.
* @target: The target describing the event context. This will be
* implementation defined.
@@ -281,7 +283,7 @@ e_event_emit (EEvent *event,
/**
* e_event_target_new:
- * @ep: An initialised EEvent instance.
+ * @event: An initialised EEvent instance.
* @type: type, up to implementor
* @size: The size of memory to allocate. This must be >= sizeof(EEventTarget).
*
@@ -310,18 +312,17 @@ e_event_target_new (EEvent *event,
/**
* e_event_target_free:
- * @ep: An initialised EEvent instance on which this target was allocated.
- * @o: The target to free.
+ * @event: An initialised EEvent instance on which this target was allocated.
+ * @target: The target to free.
*
* Free a target. This invokes the virtual free method on the EEventClass.
**/
void
e_event_target_free (EEvent *event,
- gpointer object)
+ gpointer target)
{
- EEventTarget *target = object;
-
- E_EVENT_GET_CLASS (event)->target_free (event, target);
+ E_EVENT_GET_CLASS (event)->target_free (
+ event, (EEventTarget *) target);
}
/* ********************************************************************** */
@@ -510,17 +511,18 @@ e_event_hook_init (EEventHook *hook)
/**
* e_event_hook_class_add_target_map:
- * @class: The derived EEventHook class.
- * @map: A map used to describe a single EEventTarget type for this
- * class.
+ * @hook_class: The derived EEventHook class.
+ * @map: A map used to describe a single EEventTarget type for this class.
*
* Add a target map to a concrete derived class of EEvent. The target
* map enumerates a single target type and th eenable mask bit names,
* so that the type can be loaded automatically by the base EEvent class.
**/
-void e_event_hook_class_add_target_map (EEventHookClass *class,
- const EEventHookTargetMap *map)
+void
+e_event_hook_class_add_target_map (EEventHookClass *hook_class,
+ const EEventHookTargetMap *map)
{
g_hash_table_insert (
- class->target_map, (gpointer) map->type, (gpointer) map);
+ hook_class->target_map,
+ (gpointer) map->type, (gpointer) map);
}