stream-class.h: doc: fix trace/packet instead of stream/event
[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"
52ALIASES += stringft="\link ctfirstringfieldtype CTF IR string field type\endlink"
53ALIASES += structft="\link ctfirstructfieldtype CTF IR structure field type\endlink"
54ALIASES += arrayft="\link ctfirarrayfieldtype CTF IR array field type\endlink"
55ALIASES += seqft="\link ctfirseqfieldtype CTF IR sequence field type\endlink"
56ALIASES += varft="\link ctfirvarfieldtype CTF IR variant field type\endlink"
57ALIASES += intfts="\link ctfirintfieldtype CTF IR integer field types\endlink"
58ALIASES += floatfts="\link ctfirfloatfieldtype CTF IR floating point number field types\endlink"
59ALIASES += enumfts="\link ctfirenumfieldtype CTF IR enumeration field types\endlink"
60ALIASES += stringfts="\link ctfirstringfieldtype CTF IR string field types\endlink"
61ALIASES += structfts="\link ctfirstructfieldtype CTF IR structure field types\endlink"
62ALIASES += arrayfts="\link ctfirarrayfieldtype CTF IR array field types\endlink"
63ALIASES += seqfts="\link ctfirseqfieldtype CTF IR sequence field types\endlink"
64ALIASES += varfts="\link ctfirvarfieldtype CTF IR variant field types\endlink"
65ALIASES += field="\link ctfirfields CTF IR field\endlink"
66ALIASES += fields="\link ctfirfields CTF IR fields\endlink"
67ALIASES += intfield="\link ctfirintfield CTF IR integer field\endlink"
68ALIASES += floatfield="\link ctfirfloatfield CTF IR floating point number field\endlink"
69ALIASES += enumfield="\link ctfirenumfield CTF IR enumeration field\endlink"
70ALIASES += stringfield="\link ctfirstringfield CTF IR string field\endlink"
71ALIASES += structfield="\link ctfirstructfield CTF IR structure field\endlink"
72ALIASES += arrayfield="\link ctfirarrayfield CTF IR array field\endlink"
73ALIASES += seqfield="\link ctfirseqfield CTF IR sequence field\endlink"
74ALIASES += varfield="\link ctfirvarfield CTF IR variant field\endlink"
75ALIASES += intfields="\link ctfirintfield CTF IR integer fields\endlink"
76ALIASES += floatfields="\link ctfirfloatfield CTF IR floating point number fields\endlink"
77ALIASES += enumfields="\link ctfirenumfield CTF IR enumeration fields\endlink"
78ALIASES += stringfields="\link ctfirstringfield CTF IR string fields\endlink"
79ALIASES += structfields="\link ctfirstructfield CTF IR structure fields\endlink"
80ALIASES += arrayfields="\link ctfirarrayfield CTF IR array fields\endlink"
81ALIASES += seqfields="\link ctfirseqfield CTF IR sequence fields\endlink"
82ALIASES += varfields="\link ctfirvarfield CTF IR variant fields\endlink"
d1dab1d2 83ALIASES += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
54f61f03 84ALIASES += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
d1dab1d2
PP
85OPTIMIZE_OUTPUT_FOR_C = YES
86MARKDOWN_SUPPORT = YES
87TOC_INCLUDE_HEADINGS = 0
88AUTOLINK_SUPPORT = YES
89SUBGROUPING = YES
90INLINE_GROUPED_CLASSES = NO
91INLINE_SIMPLE_STRUCTS = NO
92TYPEDEF_HIDES_STRUCT = NO
93LOOKUP_CACHE_SIZE = 0
94
95EXTRACT_ALL = NO
96EXTRACT_PRIVATE = NO
97EXTRACT_PACKAGE = NO
98EXTRACT_STATIC = YES
99EXTRACT_LOCAL_CLASSES = YES
100EXTRACT_LOCAL_METHODS = NO
101EXTRACT_ANON_NSPACES = NO
102HIDE_UNDOC_MEMBERS = YES
103HIDE_UNDOC_CLASSES = YES
104HIDE_FRIEND_COMPOUNDS = NO
105HIDE_IN_BODY_DOCS = YES
106INTERNAL_DOCS = NO
107CASE_SENSE_NAMES = NO
108HIDE_SCOPE_NAMES = NO
109HIDE_COMPOUND_REFERENCE= NO
110SHOW_INCLUDE_FILES = NO
111SHOW_GROUPED_MEMB_INC = NO
112FORCE_LOCAL_INCLUDES = NO
113INLINE_INFO = YES
114SORT_MEMBER_DOCS = NO
68c8099f 115SORT_BRIEF_DOCS = NO
d1dab1d2
PP
116SORT_MEMBERS_CTORS_1ST = NO
117SORT_GROUP_NAMES = NO
118SORT_BY_SCOPE_NAME = NO
119STRICT_PROTO_MATCHING = NO
120GENERATE_TODOLIST = YES
121GENERATE_TESTLIST = YES
122GENERATE_BUGLIST = YES
123GENERATE_DEPRECATEDLIST= YES
124ENABLED_SECTIONS =
125MAX_INITIALIZER_LINES = 30
126SHOW_USED_FILES = YES
127SHOW_FILES = YES
128SHOW_NAMESPACES = NO
129FILE_VERSION_FILTER =
68c8099f 130LAYOUT_FILE = "@srcdir@/DoxygenLayout.xml"
d1dab1d2
PP
131CITE_BIB_FILES =
132
133QUIET = NO
134WARNINGS = YES
135WARN_IF_UNDOCUMENTED = YES
136WARN_IF_DOC_ERROR = YES
137WARN_NO_PARAMDOC = YES
138WARN_AS_ERROR = NO
139WARN_FORMAT = "$file:$line: $text"
140WARN_LOGFILE =
141
68c8099f
PP
142INPUT = "@top_srcdir@/include/babeltrace/ctf-ir" \
143 "@top_srcdir@/include/babeltrace/component" \
144 "@top_srcdir@/include/babeltrace/plugin" \
145 "@top_srcdir@/include/babeltrace/ref.h" \
146 "@top_srcdir@/include/babeltrace/values.h" \
d1dab1d2 147 "@srcdir@/dox/main-page.dox" \
68c8099f
PP
148 "@srcdir@/dox/write-plugin.dox" \
149 "@srcdir@/dox/use-ctf-writer.dox" \
150 "@srcdir@/dox/examples.dox" \
d1dab1d2
PP
151 "@srcdir@/dox/group-api-ref.dox" \
152 "@srcdir@/dox/group-ctf-ir.dox"
153INPUT_ENCODING = UTF-8
154FILE_PATTERNS = *.h \
155 *.hh \
156 *.hpp \
157 *.dox
68c8099f 158RECURSIVE = NO
d1dab1d2
PP
159EXCLUDE =
160EXCLUDE_SYMLINKS = NO
161EXCLUDE_PATTERNS = *-internal.h
162EXCLUDE_SYMBOLS =
163EXAMPLE_PATH =
164EXAMPLE_PATTERNS = *
165EXAMPLE_RECURSIVE = NO
166IMAGE_PATH = "@srcdir@/images"
167INPUT_FILTER =
168FILTER_PATTERNS =
169FILTER_SOURCE_FILES = NO
170FILTER_SOURCE_PATTERNS =
171USE_MDFILE_AS_MAINPAGE =
172
173SOURCE_BROWSER = NO
174INLINE_SOURCES = NO
175STRIP_CODE_COMMENTS = YES
176REFERENCED_BY_RELATION = NO
177REFERENCES_RELATION = NO
178REFERENCES_LINK_SOURCE = YES
179SOURCE_TOOLTIPS = YES
180USE_HTAGS = NO
181VERBATIM_HEADERS = YES
182
183ALPHABETICAL_INDEX = YES
184COLS_IN_ALPHA_INDEX = 5
185IGNORE_PREFIX =
186
187OUTPUT_DIRECTORY = output
188
189GENERATE_HTML = YES
190HTML_FILE_EXTENSION = .html
191HTML_HEADER =
192HTML_FOOTER =
193HTML_STYLESHEET =
194HTML_EXTRA_STYLESHEET =
195HTML_EXTRA_FILES =
196HTML_COLORSTYLE_HUE = 220
197HTML_COLORSTYLE_SAT = 100
198HTML_COLORSTYLE_GAMMA = 80
199HTML_TIMESTAMP = YES
200HTML_DYNAMIC_SECTIONS = YES
201HTML_INDEX_NUM_ENTRIES = 100
202
203GENERATE_DOCSET = NO
204GENERATE_HTMLHELP = NO
205GENERATE_CHI = NO
206GENERATE_QHP = NO
207GENERATE_ECLIPSEHELP = NO
208
209DISABLE_INDEX = NO
210GENERATE_TREEVIEW = YES
211ENUM_VALUES_PER_LINE = 4
212TREEVIEW_WIDTH = 250
213EXT_LINKS_IN_WINDOW = NO
214FORMULA_FONTSIZE = 10
215FORMULA_TRANSPARENT = YES
216USE_MATHJAX = NO
217MATHJAX_FORMAT = HTML-CSS
218MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
219MATHJAX_EXTENSIONS =
220MATHJAX_CODEFILE =
221SEARCHENGINE = YES
222SERVER_BASED_SEARCH = NO
223EXTERNAL_SEARCH = NO
224SEARCHENGINE_URL =
225SEARCHDATA_FILE = searchdata.xml
226EXTERNAL_SEARCH_ID =
227EXTRA_SEARCH_MAPPINGS =
228
229GENERATE_LATEX = NO
230GENERATE_RTF = NO
231GENERATE_MAN = NO
232GENERATE_XML = NO
233GENERATE_PERLMOD = NO
This page took 0.033187 seconds and 4 git commands to generate.