From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Tue, 1 Aug 2017 17:57:39 +0000 (-0400)
Subject: Docs: document the evaluation API
X-Git-Tag: v2.10.0~9
X-Git-Url: http://git.lttng.org/?a=commitdiff_plain;h=bfc8bc771dfbcb82d91121aeed4c56251df17edf;hp=fe0828b006c98ec6132d03f346f3e1a4e4b1ed65;p=lttng-tools.git

Docs: document the evaluation API

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

diff --git a/include/lttng/condition/evaluation.h b/include/lttng/condition/evaluation.h
index bc3a4d498..6cd0e1899 100644
--- a/include/lttng/condition/evaluation.h
+++ b/include/lttng/condition/evaluation.h
@@ -34,9 +34,18 @@ enum lttng_evaluation_status {
 	LTTNG_EVALUATION_STATUS_UNSET = -4,
 };
 
+/*
+ * Get the condition type associated with an evaluation.
+ *
+ * Returns the type of a condition on success, LTTNG_CONDITION_TYPE_UNKNOWN on
+ * error.
+ */
 extern enum lttng_condition_type lttng_evaluation_get_type(
 		const struct lttng_evaluation *evaluation);
 
+/*
+ * Destroy (frees) an evaluation object.
+ */
 extern void lttng_evaluation_destroy(struct lttng_evaluation *evaluation);
 
 #ifdef __cplusplus