X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fcallbacks.h;h=597d4b17c00479d2e48d2d510bcd9424facc90ea;hp=c0986f9eef58a71c27fe881cd06fbe8f7f547beb;hb=7c282828204b07455e48dd9986ea44d3950429ac;hpb=634d474be8d4262f5a3e549cdb6891de239f4fe4 diff --git a/include/babeltrace/ctf/callbacks.h b/include/babeltrace/ctf/callbacks.h index c0986f9e..597d4b17 100644 --- a/include/babeltrace/ctf/callbacks.h +++ b/include/babeltrace/ctf/callbacks.h @@ -43,12 +43,12 @@ struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...); /* * struct bt_dependencies must be destroyed explicitly if not passed as - * parameter to a bt_iter_add_callback(). + * parameter to a bt_ctf_iter_add_callback(). */ void babeltrace_dependencies_destroy(struct bt_dependencies *dep); /* - * bt_iter_add_callback: Add a callback to iterator. + * bt_ctf_iter_add_callback: Add a callback to iterator. * * @iter: trace collection iterator (input) * @event: event to target. 0 for all events. @@ -58,13 +58,13 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep); * * @callback: function pointer to call * @depends: struct bt_dependency detailing the required computation results. - * Ends with 0. + * Ends with 0. NULL is accepted as empty dependency. * @weak_depends: struct bt_dependency detailing the optional computation * results that can be optionally consumed by this - * callback. + * callback. NULL is accepted as empty dependency. * @provides: struct bt_dependency detailing the computation results * provided by this callback. - * Ends with 0. + * Ends with 0. NULL is accepted as empty dependency. * * "depends", "weak_depends" and "provides" memory is handled by the * babeltrace library after this call succeeds or fails. These objects @@ -72,14 +72,14 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep); * destroyed, but they belong to the babeltrace library. * * (note to implementor: we need to keep a gptrarray of struct - * bt_dependencies to "garbage collect" in struct bt_iter, and + * bt_dependencies to "garbage collect" in struct bt_ctf_iter, and * dependencies need to have a refcount to handle the case where they * would be passed to more than one iterator. Upon iterator detroy, we * iterate on all the gc ptrarray and decrement the refcounts, freeing * if we reach 0.) * (note to implementor: we calculate the dependency graph when - * bt_iter_read_event() is executed after a - * bt_iter_add_callback(). Beware that it is valid to create/add + * bt_ctf_iter_read_event() is executed after a + * bt_ctf_iter_add_callback(). Beware that it is valid to create/add * callbacks/read/add more callbacks/read some more.) */ int bt_ctf_iter_add_callback(struct bt_ctf_iter *iter,