Fix: src.ctf.lttng-live: emitting stream end msg with no stream
[babeltrace.git] / doc / api / Doxyfile.in
CommitLineData
d1dab1d2
PP
1DOXYFILE_ENCODING = UTF-8
2PROJECT_NAME = "Babeltrace C API"
3PROJECT_NUMBER = @PACKAGE_VERSION@
4PROJECT_BRIEF = "Trace converter with plugin support"
5CREATE_SUBDIRS = NO
6ALLOW_UNICODE_NAMES = NO
7OUTPUT_LANGUAGE = English
8BRIEF_MEMBER_DESC = YES
9REPEAT_BRIEF = YES
10ALWAYS_DETAILED_SEC = NO
11INLINE_INHERITED_MEMB = NO
12FULL_PATH_NAMES = YES
13STRIP_FROM_PATH = "@top_srcdir@/include"
14STRIP_FROM_INC_PATH =
15SHORT_NAMES = NO
16JAVADOC_AUTOBRIEF = NO
17QT_AUTOBRIEF = NO
18MULTILINE_CPP_IS_BRIEF = YES
19INHERIT_DOCS = YES
20SEPARATE_MEMBER_PAGES = NO
21TAB_SIZE = 4
22ALIASES =
23ALIASES += btversion="@PACKAGE_VERSION@"
24ALIASES += postsuccessrefcountretinc="@post <strong>On success</strong>, the reference count of the returned object is incremented."
25ALIASES += postsuccessrefcountret1="@post <strong>On success</strong>, the reference count of the returned object is 1."
26ALIASES += postsuccessrefcountinc{1}="@post <strong>On success</strong>, the reference count of \p \1 is incremented."
27ALIASES += postrefcountsame{1}="@post The reference count of \p \1 is not modified."
54f61f03 28ALIASES += postsuccessfrozen{1}="@post <strong>On success</strong>, \p \1 is frozen."
d1dab1d2
PP
29ALIASES += prenotnull{1}="@pre \p \1 is not \c NULL."
30ALIASES += prehot{1}="@pre \p \1 is not frozen."
68c8099f
PP
31ALIASES += preisintft{1}="@pre \p \1 is a \link ctfirintfieldtype CTF IR integer field type\endlink."
32ALIASES += preisfloatft{1}="@pre \p \1 is a \link ctfirfloatfieldtype CTF IR floating point number field type\endlink."
33ALIASES += preisenumft{1}="@pre \p \1 is a \link ctfirenumfieldtype CTF IR enumeration field type\endlink."
34ALIASES += preisstringft{1}="@pre \p \1 is a \link ctfirstringfieldtype CTF IR string field type\endlink."
35ALIASES += preisstructft{1}="@pre \p \1 is a \link ctfirstructfieldtype CTF IR structure field type\endlink."
36ALIASES += preisarrayft{1}="@pre \p \1 is a \link ctfirarrayfieldtype CTF IR array field type\endlink."
37ALIASES += preisseqft{1}="@pre \p \1 is a \link ctfirseqfieldtype CTF IR sequence field type\endlink."
38ALIASES += preisvarft{1}="@pre \p \1 is a \link ctfirvarfieldtype CTF IR variant field type\endlink."
39ALIASES += preisintfield{1}="@pre \p \1 is a \link ctfirintfield CTF IR integer field\endlink."
40ALIASES += preisfloatfield{1}="@pre \p \1 is a \link ctfirfloatfield CTF IR floating point number field\endlink."
41ALIASES += preisenumfield{1}="@pre \p \1 is a \link ctfirenumfield CTF IR enumeration field\endlink."
42ALIASES += preisstringfield{1}="@pre \p \1 is a \link ctfirstringfield CTF IR string field\endlink."
43ALIASES += preisstructfield{1}="@pre \p \1 is a \link ctfirstructfield CTF IR structure field\endlink."
44ALIASES += preisarrayfield{1}="@pre \p \1 is a \link ctfirarrayfield CTF IR array field\endlink."
45ALIASES += preisseqfield{1}="@pre \p \1 is a \link ctfirseqfield CTF IR sequence field\endlink."
46ALIASES += preisvarfield{1}="@pre \p \1 is a \link ctfirvarfield CTF IR variant field\endlink."
2a1775ac
PP
47ALIASES += ft="\link ctfirfieldtypes CTF IR field type\endlink"
48ALIASES += fts="\link ctfirfieldtypes CTF IR field types\endlink"
49ALIASES += intft="\link ctfirintfieldtype CTF IR integer field type\endlink"
50ALIASES += floatft="\link ctfirfloatfieldtype CTF IR floating point number field type\endlink"
51ALIASES += enumft="\link ctfirenumfieldtype CTF IR enumeration field type\endlink"
5c3f3b7e 52ALIASES += enumftiter="\link ctfirenumftmappingiter CTF IR enumeration field type mapping iterator\endlink"
2a1775ac
PP
53ALIASES += stringft="\link ctfirstringfieldtype CTF IR string field type\endlink"
54ALIASES += structft="\link ctfirstructfieldtype CTF IR structure field type\endlink"
55ALIASES += arrayft="\link ctfirarrayfieldtype CTF IR array field type\endlink"
56ALIASES += seqft="\link ctfirseqfieldtype CTF IR sequence field type\endlink"
57ALIASES += varft="\link ctfirvarfieldtype CTF IR variant field type\endlink"
58ALIASES += intfts="\link ctfirintfieldtype CTF IR integer field types\endlink"
59ALIASES += floatfts="\link ctfirfloatfieldtype CTF IR floating point number field types\endlink"
60ALIASES += enumfts="\link ctfirenumfieldtype CTF IR enumeration field types\endlink"
61ALIASES += stringfts="\link ctfirstringfieldtype CTF IR string field types\endlink"
62ALIASES += structfts="\link ctfirstructfieldtype CTF IR structure field types\endlink"
63ALIASES += arrayfts="\link ctfirarrayfieldtype CTF IR array field types\endlink"
64ALIASES += seqfts="\link ctfirseqfieldtype CTF IR sequence field types\endlink"
65ALIASES += varfts="\link ctfirvarfieldtype CTF IR variant field types\endlink"
66ALIASES += field="\link ctfirfields CTF IR field\endlink"
67ALIASES += fields="\link ctfirfields CTF IR fields\endlink"
68ALIASES += intfield="\link ctfirintfield CTF IR integer field\endlink"
69ALIASES += floatfield="\link ctfirfloatfield CTF IR floating point number field\endlink"
70ALIASES += enumfield="\link ctfirenumfield CTF IR enumeration field\endlink"
71ALIASES += stringfield="\link ctfirstringfield CTF IR string field\endlink"
72ALIASES += structfield="\link ctfirstructfield CTF IR structure field\endlink"
73ALIASES += arrayfield="\link ctfirarrayfield CTF IR array field\endlink"
74ALIASES += seqfield="\link ctfirseqfield CTF IR sequence field\endlink"
75ALIASES += varfield="\link ctfirvarfield CTF IR variant field\endlink"
76ALIASES += intfields="\link ctfirintfield CTF IR integer fields\endlink"
77ALIASES += floatfields="\link ctfirfloatfield CTF IR floating point number fields\endlink"
78ALIASES += enumfields="\link ctfirenumfield CTF IR enumeration fields\endlink"
79ALIASES += stringfields="\link ctfirstringfield CTF IR string fields\endlink"
80ALIASES += structfields="\link ctfirstructfield CTF IR structure fields\endlink"
81ALIASES += arrayfields="\link ctfirarrayfield CTF IR array fields\endlink"
82ALIASES += seqfields="\link ctfirseqfield CTF IR sequence fields\endlink"
83ALIASES += varfields="\link ctfirvarfield CTF IR variant fields\endlink"
d1dab1d2 84ALIASES += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
54f61f03 85ALIASES += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
bb8c17e0 86ALIASES += noteexamplesassert="@note In the following examples, we use \c assert() to validate the results of the called functions."
d1dab1d2
PP
87OPTIMIZE_OUTPUT_FOR_C = YES
88MARKDOWN_SUPPORT = YES
89TOC_INCLUDE_HEADINGS = 0
90AUTOLINK_SUPPORT = YES
91SUBGROUPING = YES
92INLINE_GROUPED_CLASSES = NO
93INLINE_SIMPLE_STRUCTS = NO
94TYPEDEF_HIDES_STRUCT = NO
95LOOKUP_CACHE_SIZE = 0
96
97EXTRACT_ALL = NO
98EXTRACT_PRIVATE = NO
99EXTRACT_PACKAGE = NO
100EXTRACT_STATIC = YES
101EXTRACT_LOCAL_CLASSES = YES
102EXTRACT_LOCAL_METHODS = NO
103EXTRACT_ANON_NSPACES = NO
104HIDE_UNDOC_MEMBERS = YES
105HIDE_UNDOC_CLASSES = YES
106HIDE_FRIEND_COMPOUNDS = NO
107HIDE_IN_BODY_DOCS = YES
108INTERNAL_DOCS = NO
109CASE_SENSE_NAMES = NO
110HIDE_SCOPE_NAMES = NO
111HIDE_COMPOUND_REFERENCE= NO
112SHOW_INCLUDE_FILES = NO
113SHOW_GROUPED_MEMB_INC = NO
114FORCE_LOCAL_INCLUDES = NO
115INLINE_INFO = YES
116SORT_MEMBER_DOCS = NO
68c8099f 117SORT_BRIEF_DOCS = NO
d1dab1d2
PP
118SORT_MEMBERS_CTORS_1ST = NO
119SORT_GROUP_NAMES = NO
120SORT_BY_SCOPE_NAME = NO
121STRICT_PROTO_MATCHING = NO
122GENERATE_TODOLIST = YES
123GENERATE_TESTLIST = YES
124GENERATE_BUGLIST = YES
125GENERATE_DEPRECATEDLIST= YES
126ENABLED_SECTIONS =
127MAX_INITIALIZER_LINES = 30
128SHOW_USED_FILES = YES
129SHOW_FILES = YES
130SHOW_NAMESPACES = NO
131FILE_VERSION_FILTER =
68c8099f 132LAYOUT_FILE = "@srcdir@/DoxygenLayout.xml"
d1dab1d2
PP
133CITE_BIB_FILES =
134
135QUIET = NO
136WARNINGS = YES
137WARN_IF_UNDOCUMENTED = YES
138WARN_IF_DOC_ERROR = YES
139WARN_NO_PARAMDOC = YES
140WARN_AS_ERROR = NO
141WARN_FORMAT = "$file:$line: $text"
142WARN_LOGFILE =
143
a8be4294
MJ
144INPUT = "@top_srcdir@/include/babeltrace2/ctf-ir" \
145 "@top_srcdir@/include/babeltrace2/component" \
146 "@top_srcdir@/include/babeltrace2/plugin" \
147 "@top_srcdir@/include/babeltrace2/ref.h" \
148 "@top_srcdir@/include/babeltrace2/values.h" \
149 "@top_srcdir@/include/babeltrace2/logging.h" \
150 "@top_srcdir@/include/babeltrace2/types.h" \
d1dab1d2 151 "@srcdir@/dox/main-page.dox" \
968e4792 152 "@srcdir@/dox/includes-build.dox" \
68c8099f
PP
153 "@srcdir@/dox/write-plugin.dox" \
154 "@srcdir@/dox/use-ctf-writer.dox" \
155 "@srcdir@/dox/examples.dox" \
bb8c17e0 156 "@srcdir@/dox/examples-ctfir.dox" \
d1dab1d2
PP
157 "@srcdir@/dox/group-api-ref.dox" \
158 "@srcdir@/dox/group-ctf-ir.dox"
159INPUT_ENCODING = UTF-8
160FILE_PATTERNS = *.h \
161 *.hh \
162 *.hpp \
163 *.dox
68c8099f 164RECURSIVE = NO
d1dab1d2
PP
165EXCLUDE =
166EXCLUDE_SYMLINKS = NO
578e048b 167EXCLUDE_PATTERNS =
d1dab1d2
PP
168EXCLUDE_SYMBOLS =
169EXAMPLE_PATH =
170EXAMPLE_PATTERNS = *
171EXAMPLE_RECURSIVE = NO
172IMAGE_PATH = "@srcdir@/images"
173INPUT_FILTER =
174FILTER_PATTERNS =
175FILTER_SOURCE_FILES = NO
176FILTER_SOURCE_PATTERNS =
177USE_MDFILE_AS_MAINPAGE =
178
179SOURCE_BROWSER = NO
180INLINE_SOURCES = NO
181STRIP_CODE_COMMENTS = YES
182REFERENCED_BY_RELATION = NO
183REFERENCES_RELATION = NO
184REFERENCES_LINK_SOURCE = YES
185SOURCE_TOOLTIPS = YES
186USE_HTAGS = NO
187VERBATIM_HEADERS = YES
188
189ALPHABETICAL_INDEX = YES
190COLS_IN_ALPHA_INDEX = 5
191IGNORE_PREFIX =
192
193OUTPUT_DIRECTORY = output
194
195GENERATE_HTML = YES
196HTML_FILE_EXTENSION = .html
197HTML_HEADER =
198HTML_FOOTER =
199HTML_STYLESHEET =
200HTML_EXTRA_STYLESHEET =
201HTML_EXTRA_FILES =
202HTML_COLORSTYLE_HUE = 220
203HTML_COLORSTYLE_SAT = 100
204HTML_COLORSTYLE_GAMMA = 80
205HTML_TIMESTAMP = YES
206HTML_DYNAMIC_SECTIONS = YES
207HTML_INDEX_NUM_ENTRIES = 100
208
209GENERATE_DOCSET = NO
210GENERATE_HTMLHELP = NO
211GENERATE_CHI = NO
212GENERATE_QHP = NO
213GENERATE_ECLIPSEHELP = NO
214
215DISABLE_INDEX = NO
216GENERATE_TREEVIEW = YES
217ENUM_VALUES_PER_LINE = 4
218TREEVIEW_WIDTH = 250
219EXT_LINKS_IN_WINDOW = NO
220FORMULA_FONTSIZE = 10
221FORMULA_TRANSPARENT = YES
222USE_MATHJAX = NO
223MATHJAX_FORMAT = HTML-CSS
224MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
225MATHJAX_EXTENSIONS =
226MATHJAX_CODEFILE =
227SEARCHENGINE = YES
228SERVER_BASED_SEARCH = NO
229EXTERNAL_SEARCH = NO
230SEARCHENGINE_URL =
231SEARCHDATA_FILE = searchdata.xml
232EXTERNAL_SEARCH_ID =
233EXTRA_SEARCH_MAPPINGS =
234
235GENERATE_LATEX = NO
236GENERATE_RTF = NO
237GENERATE_MAN = NO
238GENERATE_XML = NO
239GENERATE_PERLMOD = NO
This page took 0.060753 seconds and 4 git commands to generate.