Fix: src.ctf.lttng-live: emitting stream end msg with no stream

[babeltrace.git] / doc / api / dox / group-ctf-ir.dox

diff --git a/doc/api/dox/group-ctf-ir.dox b/doc/api/dox/group-ctf-ir.dox
index f8abd6e7b327a7bee05e35465c1f785965f55748..f7878da10caf550f37ff1028cd1b18930c2f3568 100644 (file)
--- a/doc/api/dox/group-ctf-ir.dox
+++ b/doc/api/dox/group-ctf-ir.dox
@@ -4,9 +4,18 @@
 @brief Common Trace Format Intermediate Representation.
 
 The <em>Common Trace Format Intermediate Representation</em>,
-or <strong><em>CTF IR</em></strong>, is a set of objects which are
-analogous to the model of the <a href="http://diamon.org/ctf">CTF</a>
-specification.
+or <strong><em>CTF IR</em></strong>, is the representation of the
+<a href="http://diamon.org/ctf">CTF</a> model within Babeltrace.
 
-TODO: add more stuff
+As with any Babeltrace object, all the CTF IR objects have
+<a href="https://en.wikipedia.org/wiki/Reference_counting">reference
+counts</a>. See \ref refs to learn more about the reference counting
+management of Babeltrace objects.
+
+When the documentation says that a given
+\link ctfirfieldtypes CTF IR field type\endlink must be
+<em>equivalent to</em> another one, it means that
+bt_field_type_compare() \em must return 0.
+
+@sa \ref ctfirexamples "Examples"
 */