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

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               += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
ALIASES               += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
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/babeltrace/ctf-ir" \
                         "@top_srcdir@/include/babeltrace/component" \
                         "@top_srcdir@/include/babeltrace/plugin" \
                         "@top_srcdir@/include/babeltrace/ref.h" \
                         "@top_srcdir@/include/babeltrace/values.h" \
                         "@srcdir@/dox/main-page.dox" \
                         "@srcdir@/dox/write-plugin.dox" \
                         "@srcdir@/dox/use-ctf-writer.dox" \
                         "@srcdir@/dox/examples.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       = *-internal.h
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
Commit	Line	Data
d1dab1d2 PP	1	DOXYFILE_ENCODING = UTF-8
	2	PROJECT_NAME = "Babeltrace C API"
	3	PROJECT_NUMBER = @PACKAGE_VERSION@
	4	PROJECT_BRIEF = "Trace converter with plugin support"
	5	CREATE_SUBDIRS = NO
	6	ALLOW_UNICODE_NAMES = NO
	7	OUTPUT_LANGUAGE = English
	8	BRIEF_MEMBER_DESC = YES
	9	REPEAT_BRIEF = YES
	10	ALWAYS_DETAILED_SEC = NO
	11	INLINE_INHERITED_MEMB = NO
	12	FULL_PATH_NAMES = YES
	13	STRIP_FROM_PATH = "@top_srcdir@/include"
	14	STRIP_FROM_INC_PATH =
	15	SHORT_NAMES = NO
	16	JAVADOC_AUTOBRIEF = NO
	17	QT_AUTOBRIEF = NO
	18	MULTILINE_CPP_IS_BRIEF = YES
	19	INHERIT_DOCS = YES
	20	SEPARATE_MEMBER_PAGES = NO
	21	TAB_SIZE = 4
	22	ALIASES =
	23	ALIASES += btversion="@PACKAGE_VERSION@"
	24	ALIASES += postsuccessrefcountretinc="@post <strong>On success</strong>, the reference count of the returned object is incremented."
	25	ALIASES += postsuccessrefcountret1="@post <strong>On success</strong>, the reference count of the returned object is 1."
	26	ALIASES += postsuccessrefcountinc{1}="@post <strong>On success</strong>, the reference count of \p \1 is incremented."
	27	ALIASES += postrefcountsame{1}="@post The reference count of \p \1 is not modified."
54f61f03	28	ALIASES += postsuccessfrozen{1}="@post <strong>On success</strong>, \p \1 is frozen."
d1dab1d2 PP	29	ALIASES += prenotnull{1}="@pre \p \1 is not \c NULL."
d1dab1d2 PP	30	ALIASES += prehot{1}="@pre \p \1 is not frozen."
68c8099f PP	31	ALIASES += preisintft{1}="@pre \p \1 is a \link ctfirintfieldtype CTF IR integer field type\endlink."
	32	ALIASES += preisfloatft{1}="@pre \p \1 is a \link ctfirfloatfieldtype CTF IR floating point number field type\endlink."
	33	ALIASES += preisenumft{1}="@pre \p \1 is a \link ctfirenumfieldtype CTF IR enumeration field type\endlink."
	34	ALIASES += preisstringft{1}="@pre \p \1 is a \link ctfirstringfieldtype CTF IR string field type\endlink."
	35	ALIASES += preisstructft{1}="@pre \p \1 is a \link ctfirstructfieldtype CTF IR structure field type\endlink."
	36	ALIASES += preisarrayft{1}="@pre \p \1 is a \link ctfirarrayfieldtype CTF IR array field type\endlink."
	37	ALIASES += preisseqft{1}="@pre \p \1 is a \link ctfirseqfieldtype CTF IR sequence field type\endlink."
	38	ALIASES += preisvarft{1}="@pre \p \1 is a \link ctfirvarfieldtype CTF IR variant field type\endlink."
	39	ALIASES += preisintfield{1}="@pre \p \1 is a \link ctfirintfield CTF IR integer field\endlink."
	40	ALIASES += preisfloatfield{1}="@pre \p \1 is a \link ctfirfloatfield CTF IR floating point number field\endlink."
	41	ALIASES += preisenumfield{1}="@pre \p \1 is a \link ctfirenumfield CTF IR enumeration field\endlink."
	42	ALIASES += preisstringfield{1}="@pre \p \1 is a \link ctfirstringfield CTF IR string field\endlink."
	43	ALIASES += preisstructfield{1}="@pre \p \1 is a \link ctfirstructfield CTF IR structure field\endlink."
	44	ALIASES += preisarrayfield{1}="@pre \p \1 is a \link ctfirarrayfield CTF IR array field\endlink."
	45	ALIASES += preisseqfield{1}="@pre \p \1 is a \link ctfirseqfield CTF IR sequence field\endlink."
	46	ALIASES += preisvarfield{1}="@pre \p \1 is a \link ctfirvarfield CTF IR variant field\endlink."
d1dab1d2	47	ALIASES += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
54f61f03	48	ALIASES += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
d1dab1d2 PP	49	OPTIMIZE_OUTPUT_FOR_C = YES
	50	MARKDOWN_SUPPORT = YES
	51	TOC_INCLUDE_HEADINGS = 0
	52	AUTOLINK_SUPPORT = YES
	53	SUBGROUPING = YES
	54	INLINE_GROUPED_CLASSES = NO
	55	INLINE_SIMPLE_STRUCTS = NO
	56	TYPEDEF_HIDES_STRUCT = NO
	57	LOOKUP_CACHE_SIZE = 0
	58
	59	EXTRACT_ALL = NO
	60	EXTRACT_PRIVATE = NO
	61	EXTRACT_PACKAGE = NO
	62	EXTRACT_STATIC = YES
	63	EXTRACT_LOCAL_CLASSES = YES
	64	EXTRACT_LOCAL_METHODS = NO
	65	EXTRACT_ANON_NSPACES = NO
	66	HIDE_UNDOC_MEMBERS = YES
	67	HIDE_UNDOC_CLASSES = YES
	68	HIDE_FRIEND_COMPOUNDS = NO
	69	HIDE_IN_BODY_DOCS = YES
	70	INTERNAL_DOCS = NO
	71	CASE_SENSE_NAMES = NO
	72	HIDE_SCOPE_NAMES = NO
	73	HIDE_COMPOUND_REFERENCE= NO
	74	SHOW_INCLUDE_FILES = NO
	75	SHOW_GROUPED_MEMB_INC = NO
	76	FORCE_LOCAL_INCLUDES = NO
	77	INLINE_INFO = YES
	78	SORT_MEMBER_DOCS = NO
68c8099f	79	SORT_BRIEF_DOCS = NO
d1dab1d2 PP	80	SORT_MEMBERS_CTORS_1ST = NO
	81	SORT_GROUP_NAMES = NO
	82	SORT_BY_SCOPE_NAME = NO
	83	STRICT_PROTO_MATCHING = NO
	84	GENERATE_TODOLIST = YES
	85	GENERATE_TESTLIST = YES
	86	GENERATE_BUGLIST = YES
	87	GENERATE_DEPRECATEDLIST= YES
	88	ENABLED_SECTIONS =
	89	MAX_INITIALIZER_LINES = 30
	90	SHOW_USED_FILES = YES
	91	SHOW_FILES = YES
	92	SHOW_NAMESPACES = NO
	93	FILE_VERSION_FILTER =
68c8099f	94	LAYOUT_FILE = "@srcdir@/DoxygenLayout.xml"
d1dab1d2 PP	95	CITE_BIB_FILES =
	96
	97	QUIET = NO
	98	WARNINGS = YES
	99	WARN_IF_UNDOCUMENTED = YES
	100	WARN_IF_DOC_ERROR = YES
	101	WARN_NO_PARAMDOC = YES
	102	WARN_AS_ERROR = NO
	103	WARN_FORMAT = "$file:$line: $text"
	104	WARN_LOGFILE =
	105
68c8099f PP	106	INPUT = "@top_srcdir@/include/babeltrace/ctf-ir" \
	107	"@top_srcdir@/include/babeltrace/component" \
	108	"@top_srcdir@/include/babeltrace/plugin" \
	109	"@top_srcdir@/include/babeltrace/ref.h" \
	110	"@top_srcdir@/include/babeltrace/values.h" \
d1dab1d2	111	"@srcdir@/dox/main-page.dox" \
68c8099f PP	112	"@srcdir@/dox/write-plugin.dox" \
	113	"@srcdir@/dox/use-ctf-writer.dox" \
	114	"@srcdir@/dox/examples.dox" \
d1dab1d2 PP	115	"@srcdir@/dox/group-api-ref.dox" \
	116	"@srcdir@/dox/group-ctf-ir.dox"
	117	INPUT_ENCODING = UTF-8
	118	FILE_PATTERNS = *.h \
	119	*.hh \
	120	*.hpp \
	121	*.dox
68c8099f	122	RECURSIVE = NO
d1dab1d2 PP	123	EXCLUDE =
	124	EXCLUDE_SYMLINKS = NO
	125	EXCLUDE_PATTERNS = *-internal.h
	126	EXCLUDE_SYMBOLS =
	127	EXAMPLE_PATH =
	128	EXAMPLE_PATTERNS = *
	129	EXAMPLE_RECURSIVE = NO
	130	IMAGE_PATH = "@srcdir@/images"
	131	INPUT_FILTER =
	132	FILTER_PATTERNS =
	133	FILTER_SOURCE_FILES = NO
	134	FILTER_SOURCE_PATTERNS =
	135	USE_MDFILE_AS_MAINPAGE =
	136
	137	SOURCE_BROWSER = NO
	138	INLINE_SOURCES = NO
	139	STRIP_CODE_COMMENTS = YES
	140	REFERENCED_BY_RELATION = NO
	141	REFERENCES_RELATION = NO
	142	REFERENCES_LINK_SOURCE = YES
	143	SOURCE_TOOLTIPS = YES
	144	USE_HTAGS = NO
	145	VERBATIM_HEADERS = YES
	146
	147	ALPHABETICAL_INDEX = YES
	148	COLS_IN_ALPHA_INDEX = 5
	149	IGNORE_PREFIX =
	150
	151	OUTPUT_DIRECTORY = output
	152
	153	GENERATE_HTML = YES
	154	HTML_FILE_EXTENSION = .html
	155	HTML_HEADER =
	156	HTML_FOOTER =
	157	HTML_STYLESHEET =
	158	HTML_EXTRA_STYLESHEET =
	159	HTML_EXTRA_FILES =
	160	HTML_COLORSTYLE_HUE = 220
	161	HTML_COLORSTYLE_SAT = 100
	162	HTML_COLORSTYLE_GAMMA = 80
	163	HTML_TIMESTAMP = YES
	164	HTML_DYNAMIC_SECTIONS = YES
	165	HTML_INDEX_NUM_ENTRIES = 100
	166
	167	GENERATE_DOCSET = NO
	168	GENERATE_HTMLHELP = NO
	169	GENERATE_CHI = NO
	170	GENERATE_QHP = NO
	171	GENERATE_ECLIPSEHELP = NO
	172
	173	DISABLE_INDEX = NO
	174	GENERATE_TREEVIEW = YES
	175	ENUM_VALUES_PER_LINE = 4
	176	TREEVIEW_WIDTH = 250
	177	EXT_LINKS_IN_WINDOW = NO
	178	FORMULA_FONTSIZE = 10
	179	FORMULA_TRANSPARENT = YES
	180	USE_MATHJAX = NO
	181	MATHJAX_FORMAT = HTML-CSS
	182	MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
	183	MATHJAX_EXTENSIONS =
	184	MATHJAX_CODEFILE =
	185	SEARCHENGINE = YES
	186	SERVER_BASED_SEARCH = NO
187	EXTERNAL_SEARCH = NO
188	SEARCHENGINE_URL =
189	SEARCHDATA_FILE = searchdata.xml
190	EXTERNAL_SEARCH_ID =
191	EXTRA_SEARCH_MAPPINGS =
192
193	GENERATE_LATEX = NO
194	GENERATE_RTF = NO
195	GENERATE_MAN = NO
196	GENERATE_XML = NO
197	GENERATE_PERLMOD = NO