From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Tue, 1 Aug 2017 18:29:02 +0000 (-0400)
Subject: Docs: document the notification API
X-Git-Tag: v2.11.0-rc1~462
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=e83f32158ffc15c7e18f3d9a8944ca6f70bf983e;p=lttng-tools.git

Docs: document the notification API

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

diff --git a/include/lttng/notification/notification.h b/include/lttng/notification/notification.h
index dcaf9745a..e938a0029 100644
--- a/include/lttng/notification/notification.h
+++ b/include/lttng/notification/notification.h
@@ -27,16 +27,39 @@ struct lttng_evaluation;
 struct lttng_notification;
 
 /*
- * The notification retains ownership of both the condition and evaluation.
- * Destroying the notification will also destroy the notification and evaluation
- * objects.
+ * Get a notification's condition.
+ *
+ * The notification retains the ownership of both the condition and evaluation
+ * objects. Hence, it is not valid to access those objects after the destruction
+ * of their associated notification.
+ *
+ * The caller should check the condition's type in order to use the appropriate
+ * specialized functions to access the condition's properties.
+ *
+ * Returns an lttng_condition object on success, NULL on error.
  */
 extern const struct lttng_condition *lttng_notification_get_condition(
 		struct lttng_notification *notification);
 
+/*
+ * Get a notification's condition's evaluation.
+ *
+ * The notification retains the ownership of the evaluation object. Hence, it is
+ * not valid to access that object after the destruction of its associated
+ * notification.
+ *
+ * The caller should check the evaluation's type in order to use the appropriate
+ * specialized functions to access the evaluation's properties.
+ *
+ * Returns an lttng_evaluation object on success, NULL on error.
+ */
 extern const struct lttng_evaluation *lttng_notification_get_evaluation(
 		struct lttng_notification *notification);
 
+/*
+ * Destroys (frees) a notification. The notification's condition and evaluation
+ * are destroyed as a side-effect.
+ */
 extern void lttng_notification_destroy(struct lttng_notification *notification);
 
 #ifdef __cplusplus