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

/**
@defgroup ctfir CTF IR
@ingroup apiref
@brief Common Trace Format Intermediate Representation.

The <em>Common Trace Format Intermediate Representation</em>,
or <strong><em>CTF IR</em></strong>, is the representation of the
<a href="http://diamon.org/ctf">CTF</a> model within Babeltrace.

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"
*/
Commit	Line	Data
d1dab1d2 PP	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>,
3db22dc0 PP	7	or <strong><em>CTF IR</em></strong>, is the representation of the
3db22dc0 PP	8	<a href="http://diamon.org/ctf">CTF</a> model within Babeltrace.
d1dab1d2	9
3db22dc0 PP	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
50842bdc	18	bt_field_type_compare() \em must return 0.
bb8c17e0 PP	19
bb8c17e0 PP	20	@sa \ref ctfirexamples "Examples"
d1dab1d2	21	*/