Docs: document the lttng_condition API

[lttng-tools.git] / include / lttng / condition / condition.h

diff --git a/include/lttng/condition/condition.h b/include/lttng/condition/condition.h
index 38a071e63472b111c896aec51fc88365e34ac011..71762ab017e0e9396530ff9e515d7447193e6e81 100644 (file)
--- a/include/lttng/condition/condition.h
+++ b/include/lttng/condition/condition.h
@@ -40,9 +40,18 @@ enum lttng_condition_status {
        LTTNG_CONDITION_STATUS_UNSET = -4,
 };
 
+/*
+ * Get the type of a condition.
+ *
+ * Returns the type of a condition on success, LTTNG_CONDITION_TYPE_UNKNOWN on
+ * error.
+ */
 extern enum lttng_condition_type lttng_condition_get_type(
                const struct lttng_condition *condition);
 
+/*
+ * Destroy (frees) a condition object.
+ */
 extern void lttng_condition_destroy(struct lttng_condition *condition);
 
 #ifdef __cplusplus