doc/api/liblttng-ctl/Doxyfile.in

   1 DOXYFILE_ENCODING       = UTF-8
   2 PROJECT_NAME            = "LTTng control library C API"
   3 PROJECT_NUMBER          = @PACKAGE_VERSION@
   4 CREATE_SUBDIRS          = NO
   5 ALLOW_UNICODE_NAMES     = NO
   6 OUTPUT_LANGUAGE         = English
   7 BRIEF_MEMBER_DESC       = YES
   8 REPEAT_BRIEF            = YES
   9 ALWAYS_DETAILED_SEC     = NO
  10 INLINE_INHERITED_MEMB   = NO
  11 FULL_PATH_NAMES         = YES
  12 STRIP_FROM_PATH         = "@top_srcdir@/include"
  13 STRIP_FROM_INC_PATH     =
  14 SHORT_NAMES             = NO
  15 JAVADOC_AUTOBRIEF       = NO
  16 QT_AUTOBRIEF            = NO
  17 MULTILINE_CPP_IS_BRIEF  = YES
  18 INHERIT_DOCS            = YES
  19 SEPARATE_MEMBER_PAGES   = NO
  20 TAB_SIZE                = 4
  21 ALIASES                 =
  22
  23 # Aliases: general
  24 ALIASES                += lt_version="@PACKAGE_VERSION@"
  25 ALIASES                += lt_version_maj_min="@MAJOR_VERSION@.@MINOR_VERSION@"
  26 ALIASES                += lt_api="LTTng control library&nbsp;C&nbsp;API"
  27 ALIASES                += lt_p{1}="<code class=\"lt-param\">\1</code>"
  28 ALIASES                += lt_var{1}="<strong class=\"lt-var\">\1</strong>"
  29 ALIASES                += lt_dt_opt="<strong><em>Optional</em></strong>:"
  30 ALIASES                += lt_man_nl{2}="<code><strong>\1</strong>(\2)</code>"
  31 ALIASES                += lt_man{2}="<a href=\"https://lttng.org/man/\2/\1/v\lt_version_maj_min/\">\lt_man_nl{\1,\2}</a>"
  32 ALIASES                += lt_man_gen{2}="<a href=\"https://man7.org/linux/man-pages/man\2/\1.\2.html\">\lt_man_nl{\1,\2}</a>"
  33 ALIASES                += lt_voidp="<code>void&nbsp;*</code>"
  34
  35 # Aliases: preconditions
  36 ALIASES                += lt_pre_not_null{1}="@pre \lt_p{\1} is \em not \c NULL."
  37 ALIASES                += lt_pre_valid_c_str{1}="@pre \lt_p{\1} is a valid (null-terminated) C&nbsp;string."
  38 ALIASES                += lt_pre_sess_exists{1}="@pre \lt_p{\1} names an accessible \ref api_session \"recording session\" within the \ref api-gen-sessiond-conn \"connected session daemon\"."
  39 ALIASES                += lt_pre_sess_never_active{1}="@pre \lt_p{\1} names a \ref api_session \"recording session\" which never became \link lttng_session::enabled active\endlink (started) since its creation."
  40 ALIASES                += lt_pre_sess_active{1}="@pre \lt_p{\1} names an \link lttng_session::enabled active\endlink (started) \ref api_session \"recording session\"."
  41 ALIASES                += lt_pre_sess_inactive{1}="@pre \lt_p{\1} names an \link lttng_session::enabled inactive\endlink (stopped) \ref api_session \"recording session\"."
  42 ALIASES                += lt_pre_sess_name_not_auto{1}="@pre \lt_p{\1} is not \c auto."
  43 ALIASES                += lt_pre_conn="@pre liblttng-ctl can \ref api-gen-sessiond-conn \"connect to a session daemon\"."
  44 ALIASES                += lt_pre_has_type{2}="@pre \lt_p{\1} has the type #\2."
  45
  46 # Aliases: default values
  47 ALIASES                += lt_def_net_ctrl_port="@DEFAULT_NETWORK_CONTROL_PORT@"
  48 ALIASES                += lt_def_net_data_port="@DEFAULT_NETWORK_DATA_PORT@"
  49 ALIASES                += lt_def_net_ctrl_url="<code>net://127.0.0.1:@DEFAULT_NETWORK_CONTROL_PORT@</code>"
  50 ALIASES                += lt_def_net_data_url="<code>net://127.0.0.1:@DEFAULT_NETWORK_DATA_PORT@</code>"
  51 ALIASES                += lt_def_net_url="<code>net://127.0.0.1:@DEFAULT_NETWORK_CONTROL_PORT@:@DEFAULT_NETWORK_DATA_PORT@</code>"
  52
  53 # Aliases: object names
  54 ALIASES                += lt_obj_session="\ref api_session \"recording session\""
  55 ALIASES                += lt_obj_c_session="\ref api_session \"Recording session\""
  56 ALIASES                += lt_obj_session_descr="\ref api_session_descr \"recording session descriptor\""
  57 ALIASES                += lt_obj_c_session_descr="\ref api_session_descr \"Recording session descriptor\""
  58 ALIASES                += lt_obj_domain="\ref api-channel-domain \"tracing domain\""
  59 ALIASES                += lt_obj_domains="\ref api-channel-domain \"tracing domains\""
  60 ALIASES                += lt_obj_c_domain="\ref api-channel-domain \"Tracing domain\""
  61 ALIASES                += lt_obj_channel="\ref api-channel-channel \"channel\""
  62 ALIASES                += lt_obj_channels="\ref api-channel-channel \"channels\""
  63 ALIASES                += lt_obj_c_channel="\ref api-channel-channel \"Channel\""
  64 ALIASES                += lt_obj_rer="\ref api_rer \"recording event rule\""
  65 ALIASES                += lt_obj_rers="\ref api_rer \"recording event rules\""
  66 ALIASES                += lt_obj_c_rer="\ref api_rer \"Recording event rule\""
  67 ALIASES                += lt_obj_trigger="\ref api_trigger \"trigger\""
  68 ALIASES                += lt_obj_triggers="\ref api_trigger \"triggers\""
  69 ALIASES                += lt_obj_c_trigger="\ref api_trigger \"Trigger\""
  70
  71
  72 OPTIMIZE_OUTPUT_FOR_C   = YES
  73 MARKDOWN_SUPPORT        = NO
  74 TOC_INCLUDE_HEADINGS    = 0
  75 AUTOLINK_SUPPORT        = YES
  76 SUBGROUPING             = YES
  77 INLINE_GROUPED_CLASSES  = NO
  78 INLINE_SIMPLE_STRUCTS   = NO
  79 TYPEDEF_HIDES_STRUCT    = NO
  80 LOOKUP_CACHE_SIZE       = 0
  81
  82 EXTRACT_ALL             = NO
  83 EXTRACT_PRIVATE         = NO
  84 EXTRACT_PACKAGE         = NO
  85 EXTRACT_STATIC          = YES
  86 EXTRACT_LOCAL_CLASSES   = YES
  87 EXTRACT_LOCAL_METHODS   = NO
  88 EXTRACT_ANON_NSPACES    = NO
  89 HIDE_UNDOC_MEMBERS      = YES
  90 HIDE_UNDOC_CLASSES      = YES
  91 HIDE_FRIEND_COMPOUNDS   = NO
  92 HIDE_IN_BODY_DOCS       = YES
  93 INTERNAL_DOCS           = NO
  94 CASE_SENSE_NAMES        = NO
  95 HIDE_SCOPE_NAMES        = NO
  96 HIDE_COMPOUND_REFERENCE = NO
  97 SHOW_INCLUDE_FILES      = NO
  98 SHOW_GROUPED_MEMB_INC   = NO
  99 FORCE_LOCAL_INCLUDES    = NO
 100 INLINE_INFO             = YES
 101 SORT_MEMBER_DOCS        = YES
 102 SORT_BRIEF_DOCS         = YES
 103 SORT_MEMBERS_CTORS_1ST  = NO
 104 SORT_GROUP_NAMES        = NO
 105 SORT_BY_SCOPE_NAME      = NO
 106 STRICT_PROTO_MATCHING   = NO
 107 GENERATE_TODOLIST       = YES
 108 GENERATE_TESTLIST       = YES
 109 GENERATE_BUGLIST        = YES
 110 GENERATE_DEPRECATEDLIST = YES
 111 ENABLED_SECTIONS        =
 112 MAX_INITIALIZER_LINES   = 0
 113 SHOW_USED_FILES         = NO
 114 SHOW_FILES              = NO
 115 SHOW_NAMESPACES         = NO
 116 FILE_VERSION_FILTER     =
 117 LAYOUT_FILE             = "@srcdir@/DoxygenLayout.xml"
 118 CITE_BIB_FILES          =
 119
 120 QUIET                   = NO
 121 WARNINGS                = YES
 122 WARN_IF_UNDOCUMENTED    = YES
 123 WARN_IF_DOC_ERROR       = YES
 124 WARN_NO_PARAMDOC        = YES
 125 WARN_AS_ERROR           = NO
 126 WARN_FORMAT             = "$file:$line: $text"
 127 WARN_LOGFILE            =
 128
 129 INPUT                   = "@srcdir@/dox/groups.dox" \
 130                           "@top_srcdir@/include/lttng/constant.h" \
 131                           "@top_srcdir@/include/lttng/handle.h" \
 132                           "@top_srcdir@/include/lttng/lttng.h" \
 133                           "@top_srcdir@/include/lttng/lttng-error.h" \
 134                           "@top_srcdir@/include/lttng/clear.h" \
 135                           "@top_srcdir@/include/lttng/clear-handle.h" \
 136                           "@top_srcdir@/include/lttng/session.h" \
 137                           "@top_srcdir@/include/lttng/session-descriptor.h" \
 138                           "@top_srcdir@/include/lttng/destruction-handle.h" \
 139                           "@top_srcdir@/include/lttng/domain.h" \
 140                           "@top_srcdir@/include/lttng/channel.h" \
 141                           "@top_srcdir@/include/lttng/event.h"
 142 INPUT_ENCODING          = UTF-8
 143 FILE_PATTERNS           = *.h *.dox
 144 RECURSIVE               = NO
 145 EXCLUDE                 =
 146 EXCLUDE_SYMLINKS        = NO
 147 EXCLUDE_PATTERNS        =
 148 EXCLUDE_SYMBOLS         =
 149 EXAMPLE_PATTERNS        = *
 150 EXAMPLE_RECURSIVE       = NO
 151 IMAGE_PATH              = "@srcdir@/images"
 152 INPUT_FILTER            =
 153 FILTER_PATTERNS         =
 154 FILTER_SOURCE_FILES     = NO
 155 FILTER_SOURCE_PATTERNS  =
 156 USE_MDFILE_AS_MAINPAGE  =
 157
 158 SOURCE_BROWSER          = NO
 159 INLINE_SOURCES          = NO
 160 STRIP_CODE_COMMENTS     = YES
 161 REFERENCED_BY_RELATION  = NO
 162 REFERENCES_RELATION     = NO
 163 REFERENCES_LINK_SOURCE  = NO
 164 SOURCE_TOOLTIPS         = YES
 165 USE_HTAGS               = NO
 166 VERBATIM_HEADERS        = YES
 167
 168 ALPHABETICAL_INDEX      = YES
 169 IGNORE_PREFIX           =
 170
 171 OUTPUT_DIRECTORY        = @builddir@/output
 172
 173 GENERATE_HTML           = YES
 174 HTML_FILE_EXTENSION     = .html
 175 HTML_HEADER             =
 176 HTML_FOOTER             =
 177 HTML_STYLESHEET         =
 178 HTML_EXTRA_STYLESHEET   = @srcdir@/style.css
 179 HTML_EXTRA_FILES        =
 180 HTML_COLORSTYLE_HUE     = 220
 181 HTML_COLORSTYLE_SAT     = 100
 182 HTML_COLORSTYLE_GAMMA   = 120
 183 HTML_TIMESTAMP          = NO
 184 HTML_DYNAMIC_SECTIONS   = NO
 185 HTML_DYNAMIC_MENUS      = NO
 186 HTML_INDEX_NUM_ENTRIES  = 100
 187
 188 GENERATE_DOCSET         = NO
 189 GENERATE_HTMLHELP       = NO
 190 GENERATE_CHI            = NO
 191 GENERATE_QHP            = NO
 192 GENERATE_ECLIPSEHELP    = NO
 193
 194 DISABLE_INDEX           = NO
 195 GENERATE_TREEVIEW       = YES
 196 ENUM_VALUES_PER_LINE    = 4
 197 TREEVIEW_WIDTH          = 300
 198 EXT_LINKS_IN_WINDOW     = NO
 199 FORMULA_FONTSIZE        = 10
 200 FORMULA_TRANSPARENT     = YES
 201 USE_MATHJAX             = NO
 202 MATHJAX_FORMAT          = HTML-CSS
 203 MATHJAX_RELPATH         = http://cdn.mathjax.org/mathjax/latest
 204 MATHJAX_EXTENSIONS      =
 205 MATHJAX_CODEFILE        =
 206 SEARCHENGINE            = YES
 207 SERVER_BASED_SEARCH     = NO
 208 EXTERNAL_SEARCH         = NO
 209 SEARCHENGINE_URL        =
 210 SEARCHDATA_FILE         = searchdata.xml
 211 EXTERNAL_SEARCH_ID      =
 212 EXTRA_SEARCH_MAPPINGS   =
 213
 214 GENERATE_LATEX          = NO
 215 GENERATE_RTF            = NO
 216 GENERATE_MAN            = NO
 217 GENERATE_XML            = NO
 218 GENERATE_PERLMOD        = NO