Docs: prefer 'release' to 'free' in API documentation

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

diff --git a/include/lttng/condition/condition.h b/include/lttng/condition/condition.h
index 38a071e63472b111c896aec51fc88365e34ac011..f179856e2a7c28fc4805297ec0334b2504c01365 100644 (file)
--- a/include/lttng/condition/condition.h
+++ b/include/lttng/condition/condition.h
@@ -18,8 +18,6 @@
 #ifndef LTTNG_CONDITION_H
 #define LTTNG_CONDITION_H
 
-#include <lttng/lttng.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -30,6 +28,7 @@ enum lttng_condition_type {
        LTTNG_CONDITION_TYPE_UNKNOWN = -1,
        LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW = 102,
        LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH = 101,
+       LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE = 100,
 };
 
 enum lttng_condition_status {
@@ -40,9 +39,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 (release) a condition object.
+ */
 extern void lttng_condition_destroy(struct lttng_condition *condition);
 
 #ifdef __cplusplus