From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Tue, 1 Aug 2017 16:25:57 +0000 (-0400)
Subject: Docs: document the lttng_condition API
X-Git-Tag: v2.11.0-rc1~465
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=a6d9b795a52f71e0a031c0b58798f88a971c6737;p=lttng-tools.git

Docs: document the lttng_condition API

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

diff --git a/include/lttng/condition/condition.h b/include/lttng/condition/condition.h
index 38a071e63..71762ab01 100644
--- 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