X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Ftrace.h;h=840ebf372c2383327a71a623803bc6ef982249cb;hb=4cdafd515891b2541a078030c4cfc1a17c6f2315;hp=93878ebc3e837442e23ecc2ce0061adfd21d8918;hpb=269b496c1560c8dde32cb312d20d75796063998a;p=babeltrace.git

diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index 93878ebc..840ebf37 100644
--- a/include/babeltrace/ctf-ir/trace.h
+++ b/include/babeltrace/ctf-ir/trace.h
@@ -680,6 +680,13 @@ You can only add a given stream class to one trace class.
 
 You can call this function even if \p trace_class is frozen.
 
+This function tries to resolve the needed
+\link ctfirfieldtypes CTF IR field type\endlink of the dynamic field
+types that are found anywhere in the root field types of
+\p stream_class and of all its currently contained
+\link ctfireventclass CTF IR event classes\endlink. If any automatic
+resolving fails, then this function fails.
+
 @param[in] trace_class	Trace class to which to add \p stream_class.
 @param[in] stream_class	Stream class to add to \p trace_class.
 @returns		0 on success, or a negative value on error.