API doc: document include files and how to build

[babeltrace.git] / doc / api / Doxyfile.in

diff --git a/doc/api/Doxyfile.in b/doc/api/Doxyfile.in
index 8be69c56385d2361a4d2cf7136b3ff95a22df18d..7cff9c7987c8a1a09d7ed904dbec2b034fa87c30 100644 (file)
--- a/doc/api/Doxyfile.in
+++ b/doc/api/Doxyfile.in
@@ -49,6 +49,7 @@ ALIASES               += fts="\link ctfirfieldtypes CTF IR field types\endlink"
 ALIASES               += intft="\link ctfirintfieldtype CTF IR integer field type\endlink"
 ALIASES               += floatft="\link ctfirfloatfieldtype CTF IR floating point number field type\endlink"
 ALIASES               += enumft="\link ctfirenumfieldtype CTF IR enumeration field type\endlink"
+ALIASES               += enumftiter="\link ctfirenumftmappingiter CTF IR enumeration field type mapping iterator\endlink"
 ALIASES               += stringft="\link ctfirstringfieldtype CTF IR string field type\endlink"
 ALIASES               += structft="\link ctfirstructfieldtype CTF IR structure field type\endlink"
 ALIASES               += arrayft="\link ctfirarrayfieldtype CTF IR array field type\endlink"
@@ -82,6 +83,7 @@ ALIASES               += seqfields="\link ctfirseqfield CTF IR sequence fields\e
 ALIASES               += varfields="\link ctfirvarfield CTF IR variant fields\endlink"
 ALIASES               += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
 ALIASES               += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
+ALIASES               += noteexamplesassert="@note In the following examples, we use \c assert() to validate the results of the called functions."
 OPTIMIZE_OUTPUT_FOR_C  = YES
 MARKDOWN_SUPPORT       = YES
 TOC_INCLUDE_HEADINGS   = 0
@@ -145,9 +147,11 @@ INPUT                  = "@top_srcdir@/include/babeltrace/ctf-ir" \
                          "@top_srcdir@/include/babeltrace/ref.h" \
                          "@top_srcdir@/include/babeltrace/values.h" \
                          "@srcdir@/dox/main-page.dox" \
+                         "@srcdir@/dox/includes-build.dox" \
                          "@srcdir@/dox/write-plugin.dox" \
                          "@srcdir@/dox/use-ctf-writer.dox" \
                          "@srcdir@/dox/examples.dox" \
+                         "@srcdir@/dox/examples-ctfir.dox" \
                          "@srcdir@/dox/group-api-ref.dox" \
                          "@srcdir@/dox/group-ctf-ir.dox"
 INPUT_ENCODING         = UTF-8