doc/api/Doxyfile.in

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