From 68115b31ee5ebb71e5dffe84b279e59d0cd38408 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Tue, 1 Aug 2017 13:57:39 -0400 Subject: [PATCH] Docs: document the evaluation API MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/lttng/condition/evaluation.h | 9 +++++++++ 1 file changed, 9 insertions(+) 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 -- 2.34.1