Add documentation to bt_ctf_clock_set_name

[babeltrace.git] / include / babeltrace / ctf-ir / clock.h

diff --git a/include/babeltrace/ctf-ir/clock.h b/include/babeltrace/ctf-ir/clock.h
index 93d4cbef5a6c6d0d0b9abf3bb8f122d225071477..03f335fb836719a015b02ae04bbd9a49f91570f1 100644 (file)
--- a/include/babeltrace/ctf-ir/clock.h
+++ b/include/babeltrace/ctf-ir/clock.h
@@ -61,6 +61,17 @@ extern struct bt_ctf_clock *bt_ctf_clock_create(const char *name);
  */
 extern const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock);
 
+/*
+ * bt_ctf_clock_set_name: set a clock's name.
+ *
+ * Set a clock's name.
+ *
+ * @param name Name of the clock (will be copied).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_clock_set_name(struct bt_ctf_clock *clock, const char *name);
+
 /*
  * bt_ctf_clock_get_description: get a clock's description.
  *