Docs: document the lttng_action API

[lttng-tools.git] / include / lttng / action / action.h

diff --git a/include/lttng/action/action.h b/include/lttng/action/action.h
index 311f5a0fb2924872dde21c4e59df4998f3d075a4..4d07686687ef01d41121181f8025b9fb01a368ba 100644 (file)
--- 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