doc/api/dox/group-ctf-ir.dox

   1 /**
   2 @defgroup ctfir CTF IR
   3 @ingroup apiref
   4 @brief Common Trace Format Intermediate Representation.
   5
   6 The <em>Common Trace Format Intermediate Representation</em>,
   7 or <strong><em>CTF IR</em></strong>, is the representation of the
   8 <a href="http://diamon.org/ctf">CTF</a> model within Babeltrace.
   9
  10 As with any Babeltrace object, all the CTF IR objects have
  11 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
  12 counts</a>. See \ref refs to learn more about the reference counting
  13 management of Babeltrace objects.
  14
  15 When the documentation says that a given
  16 \link ctfirfieldtypes CTF IR field type\endlink must be
  17 <em>equivalent to</em> another one, it means that
  18 bt_field_type_compare() \em must return 0.
  19
  20 @sa \ref ctfirexamples "Examples"
  21 */