| 1 | /** |
| 2 | @defgroup apiref API reference |
| 3 | @brief Babeltrace C API reference. |
| 4 | |
| 5 | This module and its submodules accurately document the C API of the |
| 6 | Babeltrace library (v\btversion). See the \ref writeplugin and |
| 7 | \ref usectfwriter pages for official, procedural user guides to help |
| 8 | you get started with this API. See \ref examples for informal examples. |
| 9 | |
| 10 | The API is divided into the following modules: |
| 11 | |
| 12 | - \ref refs contains the macros and functions that you can use |
| 13 | to manage the reference count of Babeltrace objects. |
| 14 | - \ref values is a set of generic value objects which are used at |
| 15 | various locations of the API. |
| 16 | - \ref ctfir is an internal representation of the |
| 17 | <a href="http://diamon.org/ctf/">CTF</a> model which Babeltrace |
| 18 | uses as a common foundation between trace formats. |
| 19 | - \ref btcomponents is the Babeltrace component API. A component is an |
| 20 | instance of a specific component class within a trace conversion |
| 21 | graph of connected iterators. |
| 22 | - \ref ctfwriter is an API to write concrete CTF traces to the |
| 23 | file system. |
| 24 | |
| 25 | All the functions and macros documented here indicate their |
| 26 | \em preconditions and \em postconditions. Unless there is an |
| 27 | unexpected error (out of memory, resource not available, bug, etc.), |
| 28 | if you honor the preconditions when you call a function, you are |
| 29 | guaranteed that this function in turn honors the postconditions. |
| 30 | */ |