Docs: document the lttng_action_notify action type

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

diff --git a/include/lttng/action/notify.h b/include/lttng/action/notify.h
index 6c0d0ca257aee4ddab8ec61a870833beb1cbe877..04f468561dd57a18ef686fefa123d72c88521f0b 100644 (file)
--- a/include/lttng/action/notify.h
+++ b/include/lttng/action/notify.h
@@ -24,6 +24,17 @@ struct lttng_action;
 extern "C" {
 #endif
 
+/*
+ * Create a newly allocated notification action object.
+ *
+ * A "notify" action will emit a notification to all clients which have an
+ * open notification channel. In order to receive this notification, clients
+ * must have subscribed to a condition equivalent to the one paired to this
+ * notify action in a trigger.
+ *
+ * Returns a new action on success, NULL on failure. This action must be
+ * destroyed using lttng_action_destroy().
+ */
 extern struct lttng_action *lttng_action_notify_create(void);
 
 #ifdef __cplusplus