Document libbabeltrace2's C API
[babeltrace.git] / doc / api / Doxyfile.in
diff --git a/doc/api/Doxyfile.in b/doc/api/Doxyfile.in
deleted file mode 100644 (file)
index 376888c..0000000
+++ /dev/null
@@ -1,239 +0,0 @@
-DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Babeltrace C API"
-PROJECT_NUMBER         = @PACKAGE_VERSION@
-PROJECT_BRIEF          = "Trace converter with plugin support"
-CREATE_SUBDIRS         = NO
-ALLOW_UNICODE_NAMES    = NO
-OUTPUT_LANGUAGE        = English
-BRIEF_MEMBER_DESC      = YES
-REPEAT_BRIEF           = YES
-ALWAYS_DETAILED_SEC    = NO
-INLINE_INHERITED_MEMB  = NO
-FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = "@top_srcdir@/include"
-STRIP_FROM_INC_PATH    =
-SHORT_NAMES            = NO
-JAVADOC_AUTOBRIEF      = NO
-QT_AUTOBRIEF           = NO
-MULTILINE_CPP_IS_BRIEF = YES
-INHERIT_DOCS           = YES
-SEPARATE_MEMBER_PAGES  = NO
-TAB_SIZE               = 4
-ALIASES                =
-ALIASES               += btversion="@PACKAGE_VERSION@"
-ALIASES               += postsuccessrefcountretinc="@post <strong>On success</strong>, the reference count of the returned object is incremented."
-ALIASES               += postsuccessrefcountret1="@post <strong>On success</strong>, the reference count of the returned object is 1."
-ALIASES               += postsuccessrefcountinc{1}="@post <strong>On success</strong>, the reference count of \p \1 is incremented."
-ALIASES               += postrefcountsame{1}="@post The reference count of \p \1 is not modified."
-ALIASES               += postsuccessfrozen{1}="@post <strong>On success</strong>, \p \1 is frozen."
-ALIASES               += prenotnull{1}="@pre \p \1 is not \c NULL."
-ALIASES               += prehot{1}="@pre \p \1 is not frozen."
-ALIASES               += preisintft{1}="@pre \p \1 is a \link ctfirintfieldtype CTF IR integer field type\endlink."
-ALIASES               += preisfloatft{1}="@pre \p \1 is a \link ctfirfloatfieldtype CTF IR floating point number field type\endlink."
-ALIASES               += preisenumft{1}="@pre \p \1 is a \link ctfirenumfieldtype CTF IR enumeration field type\endlink."
-ALIASES               += preisstringft{1}="@pre \p \1 is a \link ctfirstringfieldtype CTF IR string field type\endlink."
-ALIASES               += preisstructft{1}="@pre \p \1 is a \link ctfirstructfieldtype CTF IR structure field type\endlink."
-ALIASES               += preisarrayft{1}="@pre \p \1 is a \link ctfirarrayfieldtype CTF IR array field type\endlink."
-ALIASES               += preisseqft{1}="@pre \p \1 is a \link ctfirseqfieldtype CTF IR sequence field type\endlink."
-ALIASES               += preisvarft{1}="@pre \p \1 is a \link ctfirvarfieldtype CTF IR variant field type\endlink."
-ALIASES               += preisintfield{1}="@pre \p \1 is a \link ctfirintfield CTF IR integer field\endlink."
-ALIASES               += preisfloatfield{1}="@pre \p \1 is a \link ctfirfloatfield CTF IR floating point number field\endlink."
-ALIASES               += preisenumfield{1}="@pre \p \1 is a \link ctfirenumfield CTF IR enumeration field\endlink."
-ALIASES               += preisstringfield{1}="@pre \p \1 is a \link ctfirstringfield CTF IR string field\endlink."
-ALIASES               += preisstructfield{1}="@pre \p \1 is a \link ctfirstructfield CTF IR structure field\endlink."
-ALIASES               += preisarrayfield{1}="@pre \p \1 is a \link ctfirarrayfield CTF IR array field\endlink."
-ALIASES               += preisseqfield{1}="@pre \p \1 is a \link ctfirseqfield CTF IR sequence field\endlink."
-ALIASES               += preisvarfield{1}="@pre \p \1 is a \link ctfirvarfield CTF IR variant field\endlink."
-ALIASES               += ft="\link ctfirfieldtypes CTF IR field type\endlink"
-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"
-ALIASES               += seqft="\link ctfirseqfieldtype CTF IR sequence field type\endlink"
-ALIASES               += varft="\link ctfirvarfieldtype CTF IR variant field type\endlink"
-ALIASES               += intfts="\link ctfirintfieldtype CTF IR integer field types\endlink"
-ALIASES               += floatfts="\link ctfirfloatfieldtype CTF IR floating point number field types\endlink"
-ALIASES               += enumfts="\link ctfirenumfieldtype CTF IR enumeration field types\endlink"
-ALIASES               += stringfts="\link ctfirstringfieldtype CTF IR string field types\endlink"
-ALIASES               += structfts="\link ctfirstructfieldtype CTF IR structure field types\endlink"
-ALIASES               += arrayfts="\link ctfirarrayfieldtype CTF IR array field types\endlink"
-ALIASES               += seqfts="\link ctfirseqfieldtype CTF IR sequence field types\endlink"
-ALIASES               += varfts="\link ctfirvarfieldtype CTF IR variant field types\endlink"
-ALIASES               += field="\link ctfirfields CTF IR field\endlink"
-ALIASES               += fields="\link ctfirfields CTF IR fields\endlink"
-ALIASES               += intfield="\link ctfirintfield CTF IR integer field\endlink"
-ALIASES               += floatfield="\link ctfirfloatfield CTF IR floating point number field\endlink"
-ALIASES               += enumfield="\link ctfirenumfield CTF IR enumeration field\endlink"
-ALIASES               += stringfield="\link ctfirstringfield CTF IR string field\endlink"
-ALIASES               += structfield="\link ctfirstructfield CTF IR structure field\endlink"
-ALIASES               += arrayfield="\link ctfirarrayfield CTF IR array field\endlink"
-ALIASES               += seqfield="\link ctfirseqfield CTF IR sequence field\endlink"
-ALIASES               += varfield="\link ctfirvarfield CTF IR variant field\endlink"
-ALIASES               += intfields="\link ctfirintfield CTF IR integer fields\endlink"
-ALIASES               += floatfields="\link ctfirfloatfield CTF IR floating point number fields\endlink"
-ALIASES               += enumfields="\link ctfirenumfield CTF IR enumeration fields\endlink"
-ALIASES               += stringfields="\link ctfirstringfield CTF IR string fields\endlink"
-ALIASES               += structfields="\link ctfirstructfield CTF IR structure fields\endlink"
-ALIASES               += arrayfields="\link ctfirarrayfield CTF IR array fields\endlink"
-ALIASES               += seqfields="\link ctfirseqfield CTF IR sequence fields\endlink"
-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
-AUTOLINK_SUPPORT       = YES
-SUBGROUPING            = YES
-INLINE_GROUPED_CLASSES = NO
-INLINE_SIMPLE_STRUCTS  = NO
-TYPEDEF_HIDES_STRUCT   = NO
-LOOKUP_CACHE_SIZE      = 0
-
-EXTRACT_ALL            = NO
-EXTRACT_PRIVATE        = NO
-EXTRACT_PACKAGE        = NO
-EXTRACT_STATIC         = YES
-EXTRACT_LOCAL_CLASSES  = YES
-EXTRACT_LOCAL_METHODS  = NO
-EXTRACT_ANON_NSPACES   = NO
-HIDE_UNDOC_MEMBERS     = YES
-HIDE_UNDOC_CLASSES     = YES
-HIDE_FRIEND_COMPOUNDS  = NO
-HIDE_IN_BODY_DOCS      = YES
-INTERNAL_DOCS          = NO
-CASE_SENSE_NAMES       = NO
-HIDE_SCOPE_NAMES       = NO
-HIDE_COMPOUND_REFERENCE= NO
-SHOW_INCLUDE_FILES     = NO
-SHOW_GROUPED_MEMB_INC  = NO
-FORCE_LOCAL_INCLUDES   = NO
-INLINE_INFO            = YES
-SORT_MEMBER_DOCS       = NO
-SORT_BRIEF_DOCS        = NO
-SORT_MEMBERS_CTORS_1ST = NO
-SORT_GROUP_NAMES       = NO
-SORT_BY_SCOPE_NAME     = NO
-STRICT_PROTO_MATCHING  = NO
-GENERATE_TODOLIST      = YES
-GENERATE_TESTLIST      = YES
-GENERATE_BUGLIST       = YES
-GENERATE_DEPRECATEDLIST= YES
-ENABLED_SECTIONS       =
-MAX_INITIALIZER_LINES  = 30
-SHOW_USED_FILES        = YES
-SHOW_FILES             = YES
-SHOW_NAMESPACES        = NO
-FILE_VERSION_FILTER    =
-LAYOUT_FILE            = "@srcdir@/DoxygenLayout.xml"
-CITE_BIB_FILES         =
-
-QUIET                  = NO
-WARNINGS               = YES
-WARN_IF_UNDOCUMENTED   = YES
-WARN_IF_DOC_ERROR      = YES
-WARN_NO_PARAMDOC       = YES
-WARN_AS_ERROR          = NO
-WARN_FORMAT            = "$file:$line: $text"
-WARN_LOGFILE           =
-
-INPUT                  = "@top_srcdir@/include/babeltrace2/ctf-ir" \
-                         "@top_srcdir@/include/babeltrace2/component" \
-                         "@top_srcdir@/include/babeltrace2/plugin" \
-                         "@top_srcdir@/include/babeltrace2/ref.h" \
-                         "@top_srcdir@/include/babeltrace2/values.h" \
-                         "@top_srcdir@/include/babeltrace2/logging.h" \
-                         "@top_srcdir@/include/babeltrace2/types.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
-FILE_PATTERNS          = *.h \
-                         *.hh \
-                         *.hpp \
-                         *.dox
-RECURSIVE              = NO
-EXCLUDE                =
-EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       =
-EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           =
-EXAMPLE_PATTERNS       = *
-EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = "@srcdir@/images"
-INPUT_FILTER           =
-FILTER_PATTERNS        =
-FILTER_SOURCE_FILES    = NO
-FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE =
-
-SOURCE_BROWSER         = NO
-INLINE_SOURCES         = NO
-STRIP_CODE_COMMENTS    = YES
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION    = NO
-REFERENCES_LINK_SOURCE = YES
-SOURCE_TOOLTIPS        = YES
-USE_HTAGS              = NO
-VERBATIM_HEADERS       = YES
-
-ALPHABETICAL_INDEX     = YES
-COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          =
-
-OUTPUT_DIRECTORY       = output
-
-GENERATE_HTML          = YES
-HTML_FILE_EXTENSION    = .html
-HTML_HEADER            =
-HTML_FOOTER            =
-HTML_STYLESHEET        =
-HTML_EXTRA_STYLESHEET  =
-HTML_EXTRA_FILES       =
-HTML_COLORSTYLE_HUE    = 220
-HTML_COLORSTYLE_SAT    = 100
-HTML_COLORSTYLE_GAMMA  = 80
-HTML_TIMESTAMP         = YES
-HTML_DYNAMIC_SECTIONS  = YES
-HTML_INDEX_NUM_ENTRIES = 100
-
-GENERATE_DOCSET        = NO
-GENERATE_HTMLHELP      = NO
-GENERATE_CHI           = NO
-GENERATE_QHP           = NO
-GENERATE_ECLIPSEHELP   = NO
-
-DISABLE_INDEX          = NO
-GENERATE_TREEVIEW      = YES
-ENUM_VALUES_PER_LINE   = 4
-TREEVIEW_WIDTH         = 250
-EXT_LINKS_IN_WINDOW    = NO
-FORMULA_FONTSIZE       = 10
-FORMULA_TRANSPARENT    = YES
-USE_MATHJAX            = NO
-MATHJAX_FORMAT         = HTML-CSS
-MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
-MATHJAX_EXTENSIONS     =
-MATHJAX_CODEFILE       =
-SEARCHENGINE           = YES
-SERVER_BASED_SEARCH    = NO
-EXTERNAL_SEARCH        = NO
-SEARCHENGINE_URL       =
-SEARCHDATA_FILE        = searchdata.xml
-EXTERNAL_SEARCH_ID     =
-EXTRA_SEARCH_MAPPINGS  =
-
-GENERATE_LATEX         = NO
-GENERATE_RTF           = NO
-GENERATE_MAN           = NO
-GENERATE_XML           = NO
-GENERATE_PERLMOD       = NO
This page took 0.026399 seconds and 4 git commands to generate.