From e6de708a1e089f7f87be625bd703ff7309939739 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Mon, 31 Jul 2017 14:07:59 -0400 Subject: [PATCH] Docs: document the lttng_action API MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/lttng/action/action.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/lttng/action/action.h b/include/lttng/action/action.h index 311f5a0fb..4d0768668 100644 --- a/include/lttng/action/action.h +++ b/include/lttng/action/action.h @@ -29,9 +29,17 @@ enum lttng_action_type { LTTNG_ACTION_TYPE_NOTIFY = 0, }; +/* + * Get the type of an action. + * + * Returns the type of an action on success, LTTNG_ACTION_TYPE_UNKNOWN on error. + */ extern enum lttng_action_type lttng_action_get_type( struct lttng_action *action); +/* + * Destroy (frees) an action object. + */ extern void lttng_action_destroy(struct lttng_action *action); #ifdef __cplusplus -- 2.34.1