when it returns.
The function descriptions in the
-<a class="el" href="modules.html">API reference modules</a>
+<a class="el" href="topics.html">API reference</a>
list all their preconditions and postconditions, if any.
The libbabeltrace2 public functions offer a
B API functions with an object of type A. For example, because an
\bt_enum_fc \em is conceptually an \bt_int_fc, you can use any integer
field class function with an enumeration field class.
-The <a class="el" href="modules.html">API reference modules</a> always
+The <a class="el" href="topics.html">API reference pages</a> always
indicate the inheritance relations.
@subsection api-fund-object-shared-unique Shared vs. unique objects
Because you cannot get a new unique object reference, you \em must
ensure that you own the unique object's owner to keep it alive. The
- <a class="el" href="modules.html">API reference modules</a> make it
+ <a class="el" href="topics.html">API reference pages</a> make it
clear, depending on the context, which
shared object is the ultimate owner of a given unique object.
</dd>
</dl>
-In the <a class="el" href="modules.html">API reference</a>, each module
+In the <a class="el" href="topics.html">API reference</a>, each page
indicates whether the documented objects are shared or unique.
@subsection api-fund-freezing Object freezing
become frozen, recursively.
There's no function to check whether or not a given object is frozen.
-Because the <a class="el" href="modules.html">API reference modules</a>
+Because the <a class="el" href="topics.html">API reference pages</a>
document which functions freeze which objects,
the "frozen" property is only useful for libbabeltrace2 to catch
programming errors (\ref api-fund-pre-post "precondition checks").
the type #bt_value because an \bt_array_val can contain different
types of values. You must be careful to only call the functions which
apply to a specific type of such objects.
-The <a class="el" href="modules.html">API reference modules</a> make
+The <a class="el" href="topics.html">API reference pages</a> make
this clear in the precondition section. Such objects always have a
<code>*_get_type()</code> function to get the object's exact type
enumerator. For example, bt_value_get_type() returns the type enumerator
}
@endcode
-The <a class="el" href="modules.html">API reference modules</a>
+The <a class="el" href="topics.html">API reference pages</a>
document, for each function, what each return status enumerator means.
Some functions return properties or objects by output parameter. When