3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
7 PROJECT_NAME = "cryptsetup API"
9 PROJECT_BRIEF = "Public cryptsetup API"
11 OUTPUT_DIRECTORY = doxygen_api_docs
13 ALLOW_UNICODE_NAMES = NO
14 OUTPUT_LANGUAGE = English
15 OUTPUT_TEXT_DIRECTION = None
16 BRIEF_MEMBER_DESC = YES
19 ALWAYS_DETAILED_SEC = NO
20 INLINE_INHERITED_MEMB = NO
25 JAVADOC_AUTOBRIEF = NO
28 MULTILINE_CPP_IS_BRIEF = NO
29 PYTHON_DOCSTRING = YES
31 SEPARATE_MEMBER_PAGES = NO
34 OPTIMIZE_OUTPUT_FOR_C = YES
35 OPTIMIZE_OUTPUT_JAVA = NO
36 OPTIMIZE_FOR_FORTRAN = NO
37 OPTIMIZE_OUTPUT_VHDL = NO
38 OPTIMIZE_OUTPUT_SLICE = NO
40 MARKDOWN_SUPPORT = YES
41 TOC_INCLUDE_HEADINGS = 5
42 AUTOLINK_SUPPORT = YES
43 BUILTIN_STL_SUPPORT = NO
46 IDL_PROPERTY_SUPPORT = YES
47 DISTRIBUTE_GROUP_DOC = NO
48 GROUP_NESTED_COMPOUNDS = NO
50 INLINE_GROUPED_CLASSES = NO
51 INLINE_SIMPLE_STRUCTS = NO
52 TYPEDEF_HIDES_STRUCT = YES
55 #---------------------------------------------------------------------------
56 # Build related configuration options
57 #---------------------------------------------------------------------------
60 EXTRACT_PRIV_VIRTUAL = NO
63 EXTRACT_LOCAL_CLASSES = YES
64 EXTRACT_LOCAL_METHODS = NO
65 EXTRACT_ANON_NSPACES = NO
66 RESOLVE_UNNAMED_PARAMS = YES
67 HIDE_UNDOC_MEMBERS = NO
68 HIDE_UNDOC_CLASSES = NO
69 HIDE_FRIEND_COMPOUNDS = NO
70 HIDE_IN_BODY_DOCS = NO
72 CASE_SENSE_NAMES = YES
74 HIDE_COMPOUND_REFERENCE= NO
75 SHOW_INCLUDE_FILES = YES
76 SHOW_GROUPED_MEMB_INC = NO
77 FORCE_LOCAL_INCLUDES = NO
79 SORT_MEMBER_DOCS = YES
81 SORT_MEMBERS_CTORS_1ST = NO
83 SORT_BY_SCOPE_NAME = NO
84 STRICT_PROTO_MATCHING = NO
85 GENERATE_TODOLIST = YES
86 GENERATE_TESTLIST = YES
87 GENERATE_BUGLIST = YES
88 GENERATE_DEPRECATEDLIST= YES
90 MAX_INITIALIZER_LINES = 30
97 #---------------------------------------------------------------------------
98 # Configuration options related to warning and progress messages
99 #---------------------------------------------------------------------------
102 WARN_IF_UNDOCUMENTED = YES
103 WARN_IF_DOC_ERROR = YES
104 WARN_NO_PARAMDOC = NO
106 WARN_FORMAT = "$file:$line: $text"
108 #---------------------------------------------------------------------------
109 # Configuration options related to the input files
110 #---------------------------------------------------------------------------
111 INPUT = doxygen_index.h \
112 ../lib/libcryptsetup.h
113 INPUT_ENCODING = UTF-8
117 EXCLUDE_SYMLINKS = NO
120 EXAMPLE_PATH = examples
122 EXAMPLE_RECURSIVE = NO
126 FILTER_SOURCE_FILES = NO
127 FILTER_SOURCE_PATTERNS =
128 USE_MDFILE_AS_MAINPAGE =
129 #---------------------------------------------------------------------------
130 # Configuration options related to source browsing
131 #---------------------------------------------------------------------------
134 STRIP_CODE_COMMENTS = YES
135 REFERENCED_BY_RELATION = NO
136 REFERENCES_RELATION = NO
137 REFERENCES_LINK_SOURCE = YES
138 SOURCE_TOOLTIPS = YES
140 VERBATIM_HEADERS = YES
141 CLANG_ASSISTED_PARSING = NO
142 CLANG_ADD_INC_PATHS = YES
144 CLANG_DATABASE_PATH =
145 #---------------------------------------------------------------------------
146 # Configuration options related to the alphabetical class index
147 #---------------------------------------------------------------------------
148 ALPHABETICAL_INDEX = YES
150 #---------------------------------------------------------------------------
151 # Configuration options related to the HTML output
152 #---------------------------------------------------------------------------
155 HTML_FILE_EXTENSION = .html
159 HTML_EXTRA_STYLESHEET =
161 HTML_COLORSTYLE_HUE = 220
162 HTML_COLORSTYLE_SAT = 100
163 HTML_COLORSTYLE_GAMMA = 80
165 HTML_DYNAMIC_MENUS = YES
166 HTML_DYNAMIC_SECTIONS = NO
167 HTML_INDEX_NUM_ENTRIES = 100
169 DOCSET_FEEDNAME = "Doxygen generated docs"
170 DOCSET_BUNDLE_ID = org.doxygen.Project
171 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
172 DOCSET_PUBLISHER_NAME = Publisher
173 GENERATE_HTMLHELP = NO
182 QHP_NAMESPACE = org.doxygen.Project
183 QHP_VIRTUAL_FOLDER = doc
184 QHP_CUST_FILTER_NAME =
185 QHP_CUST_FILTER_ATTRS =
186 QHP_SECT_FILTER_ATTRS =
188 GENERATE_ECLIPSEHELP = NO
189 ECLIPSE_DOC_ID = org.doxygen.Project
191 GENERATE_TREEVIEW = NO
192 ENUM_VALUES_PER_LINE = 4
194 EXT_LINKS_IN_WINDOW = NO
195 HTML_FORMULA_FORMAT = png
196 FORMULA_FONTSIZE = 10
197 FORMULA_TRANSPARENT = YES
200 MATHJAX_FORMAT = HTML-CSS
201 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
205 SERVER_BASED_SEARCH = NO
208 SEARCHDATA_FILE = searchdata.xml
210 EXTRA_SEARCH_MAPPINGS =
211 #---------------------------------------------------------------------------
212 # Configuration options related to the LaTeX output
213 #---------------------------------------------------------------------------
216 LATEX_CMD_NAME = latex
217 MAKEINDEX_CMD_NAME = makeindex
218 LATEX_MAKEINDEX_CMD = makeindex
224 LATEX_EXTRA_STYLESHEET =
229 LATEX_HIDE_INDICES = NO
230 LATEX_SOURCE_CODE = NO
231 LATEX_BIB_STYLE = plain
233 LATEX_EMOJI_DIRECTORY =
234 #---------------------------------------------------------------------------
235 # Configuration options related to the RTF output
236 #---------------------------------------------------------------------------
241 RTF_STYLESHEET_FILE =
242 RTF_EXTENSIONS_FILE =
244 #---------------------------------------------------------------------------
245 # Configuration options related to the man page output
246 #---------------------------------------------------------------------------
252 #---------------------------------------------------------------------------
253 # Configuration options related to the XML output
254 #---------------------------------------------------------------------------
257 XML_PROGRAMLISTING = YES
258 XML_NS_MEMB_FILE_SCOPE = NO
259 #---------------------------------------------------------------------------
260 # Configuration options related to the DOCBOOK output
261 #---------------------------------------------------------------------------
262 GENERATE_DOCBOOK = NO
263 DOCBOOK_OUTPUT = docbook
264 DOCBOOK_PROGRAMLISTING = NO
265 #---------------------------------------------------------------------------
266 # Configuration options for the AutoGen Definitions output
267 #---------------------------------------------------------------------------
268 GENERATE_AUTOGEN_DEF = NO
269 #---------------------------------------------------------------------------
270 # Configuration options related to the Perl module output
271 #---------------------------------------------------------------------------
272 GENERATE_PERLMOD = NO
275 PERLMOD_MAKEVAR_PREFIX =
276 #---------------------------------------------------------------------------
277 # Configuration options related to the preprocessor
278 #---------------------------------------------------------------------------
279 ENABLE_PREPROCESSING = YES
281 EXPAND_ONLY_PREDEF = NO
282 SEARCH_INCLUDES = YES
284 INCLUDE_FILE_PATTERNS =
287 SKIP_FUNCTION_MACROS = YES
288 #---------------------------------------------------------------------------
289 # Configuration options related to external references
290 #---------------------------------------------------------------------------
294 EXTERNAL_GROUPS = YES
296 #---------------------------------------------------------------------------
297 # Configuration options related to the dot tool
298 #---------------------------------------------------------------------------
301 HIDE_UNDOC_RELATIONS = YES
304 DOT_FONTNAME = Helvetica
308 COLLABORATION_GRAPH = YES
311 UML_LIMIT_NUM_FIELDS = 10
313 DOT_WRAP_THRESHOLD = 17
314 TEMPLATE_RELATIONS = NO
316 INCLUDED_BY_GRAPH = YES
319 GRAPHICAL_HIERARCHY = YES
320 DIRECTORY_GRAPH = YES
321 DOT_IMAGE_FORMAT = png
329 PLANTUML_INCLUDE_PATH =
330 DOT_GRAPH_MAX_NODES = 50
331 MAX_DOT_GRAPH_DEPTH = 0
333 DOT_MULTI_TARGETS = NO
334 GENERATE_LEGEND = YES