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 CTF IR integer field type."
  32 ALIASES               += preisfloatft{1}="@pre \p \1 is a CTF IR floating point number field type."
  33 ALIASES               += preisenumft{1}="@pre \p \1 is a CTF IR enumeration field type."
  34 ALIASES               += preisstringft{1}="@pre \p \1 is a CTF IR string field type."
  35 ALIASES               += preisstructft{1}="@pre \p \1 is a CTF IR structure field type."
  36 ALIASES               += preisarrayft{1}="@pre \p \1 is a CTF IR array field type."
  37 ALIASES               += preisseqft{1}="@pre \p \1 is a CTF IR sequence field type."
  38 ALIASES               += preisvarft{1}="@pre \p \1 is a CTF IR variant field type."
  39 ALIASES               += preisintfield{1}="@pre \p \1 is a CTF IR integer field."
  40 ALIASES               += preisfloatfield{1}="@pre \p \1 is a CTF IR floating point number field."
  41 ALIASES               += preisenumfield{1}="@pre \p \1 is a CTF IR enumeration field."
  42 ALIASES               += preisstringfield{1}="@pre \p \1 is a CTF IR string field."
  43 ALIASES               += preisstructfield{1}="@pre \p \1 is a CTF IR structure field."
  44 ALIASES               += preisarrayfield{1}="@pre \p \1 is a CTF IR array field."
  45 ALIASES               += preisseqfield{1}="@pre \p \1 is a CTF IR sequence field."
  46 ALIASES               += preisvarfield{1}="@pre \p \1 is a CTF IR variant field."
  47 ALIASES               += imgpacketstructure="@image html ctf-stream-packet.png \"Structure of a CTF packet.\""
  48 ALIASES               += imgtracestructure="@image html ctf-trace.png \"Structure of a CTF trace.\""
  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
  79 SORT_BRIEF_DOCS        = YES
  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    =
  94 LAYOUT_FILE            =
  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
 106 INPUT                  = "@top_srcdir@/include" \
 107                          "@srcdir@/dox/main-page.dox" \
 108                          "@srcdir@/dox/quick-start.dox" \
 109                          "@srcdir@/dox/group-api-ref.dox" \
 110                          "@srcdir@/dox/group-ctf-ir.dox"
 111 INPUT_ENCODING         = UTF-8
 112 FILE_PATTERNS          = *.h \
 113                          *.hh \
 114                          *.hpp \
 115                          *.dox
 116 RECURSIVE              = YES
 117 EXCLUDE                =
 118 EXCLUDE_SYMLINKS       = NO
 119 EXCLUDE_PATTERNS       = *-internal.h
 120 EXCLUDE_SYMBOLS        =
 121 EXAMPLE_PATH           =
 122 EXAMPLE_PATTERNS       = *
 123 EXAMPLE_RECURSIVE      = NO
 124 IMAGE_PATH             = "@srcdir@/images"
 125 INPUT_FILTER           =
 126 FILTER_PATTERNS        =
 127 FILTER_SOURCE_FILES    = NO
 128 FILTER_SOURCE_PATTERNS =
 129 USE_MDFILE_AS_MAINPAGE =
 130
 131 SOURCE_BROWSER         = NO
 132 INLINE_SOURCES         = NO
 133 STRIP_CODE_COMMENTS    = YES
 134 REFERENCED_BY_RELATION = NO
 135 REFERENCES_RELATION    = NO
 136 REFERENCES_LINK_SOURCE = YES
 137 SOURCE_TOOLTIPS        = YES
 138 USE_HTAGS              = NO
 139 VERBATIM_HEADERS       = YES
 140
 141 ALPHABETICAL_INDEX     = YES
 142 COLS_IN_ALPHA_INDEX    = 5
 143 IGNORE_PREFIX          =
 144
 145 OUTPUT_DIRECTORY       = output
 146
 147 GENERATE_HTML          = YES
 148 HTML_FILE_EXTENSION    = .html
 149 HTML_HEADER            =
 150 HTML_FOOTER            =
 151 HTML_STYLESHEET        =
 152 HTML_EXTRA_STYLESHEET  =
 153 HTML_EXTRA_FILES       =
 154 HTML_COLORSTYLE_HUE    = 220
 155 HTML_COLORSTYLE_SAT    = 100
 156 HTML_COLORSTYLE_GAMMA  = 80
 157 HTML_TIMESTAMP         = YES
 158 HTML_DYNAMIC_SECTIONS  = YES
 159 HTML_INDEX_NUM_ENTRIES = 100
 160
 161 GENERATE_DOCSET        = NO
 162 GENERATE_HTMLHELP      = NO
 163 GENERATE_CHI           = NO
 164 GENERATE_QHP           = NO
 165 GENERATE_ECLIPSEHELP   = NO
 166
 167 DISABLE_INDEX          = NO
 168 GENERATE_TREEVIEW      = YES
 169 ENUM_VALUES_PER_LINE   = 4
 170 TREEVIEW_WIDTH         = 250
 171 EXT_LINKS_IN_WINDOW    = NO
 172 FORMULA_FONTSIZE       = 10
 173 FORMULA_TRANSPARENT    = YES
 174 USE_MATHJAX            = NO
 175 MATHJAX_FORMAT         = HTML-CSS
 176 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 177 MATHJAX_EXTENSIONS     =
 178 MATHJAX_CODEFILE       =
 179 SEARCHENGINE           = YES
 180 SERVER_BASED_SEARCH    = NO
 181 EXTERNAL_SEARCH        = NO
 182 SEARCHENGINE_URL       =
 183 SEARCHDATA_FILE        = searchdata.xml
 184 EXTERNAL_SEARCH_ID     =
 185 EXTRA_SEARCH_MAPPINGS  =
 186
 187 GENERATE_LATEX         = NO
 188 GENERATE_RTF           = NO
 189 GENERATE_MAN           = NO
 190 GENERATE_XML           = NO
 191 GENERATE_PERLMOD       = NO