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