From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Mon, 31 Jul 2017 18:07:59 +0000 (-0400)
Subject: Docs: document the lttng_action API
X-Git-Tag: v2.10.0~13
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=a1369b1bb88da48493d7e7649d16a71cfdcec3cf;p=lttng-tools.git

Docs: document the lttng_action API

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

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