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 bc3a4d498786af7a2caad352724c82a0adc5f16e..6cd0e1899d4dcb032395557487ffc0b83bdad7a3 100644 (file)
--- 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