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 BRIEF_MEMBER_DESC = YES
18 ALWAYS_DETAILED_SEC = NO
19 INLINE_INHERITED_MEMB = NO
24 JAVADOC_AUTOBRIEF = NO
26 MULTILINE_CPP_IS_BRIEF = NO
28 SEPARATE_MEMBER_PAGES = NO
32 OPTIMIZE_OUTPUT_FOR_C = YES
33 OPTIMIZE_OUTPUT_JAVA = NO
34 OPTIMIZE_FOR_FORTRAN = NO
35 OPTIMIZE_OUTPUT_VHDL = NO
37 MARKDOWN_SUPPORT = YES
38 AUTOLINK_SUPPORT = YES
39 BUILTIN_STL_SUPPORT = NO
42 IDL_PROPERTY_SUPPORT = YES
43 DISTRIBUTE_GROUP_DOC = NO
45 INLINE_GROUPED_CLASSES = NO
46 INLINE_SIMPLE_STRUCTS = NO
47 TYPEDEF_HIDES_STRUCT = YES
49 #---------------------------------------------------------------------------
50 # Build related configuration options
51 #---------------------------------------------------------------------------
56 EXTRACT_LOCAL_CLASSES = YES
57 EXTRACT_LOCAL_METHODS = NO
58 EXTRACT_ANON_NSPACES = NO
59 HIDE_UNDOC_MEMBERS = NO
60 HIDE_UNDOC_CLASSES = NO
61 HIDE_FRIEND_COMPOUNDS = NO
62 HIDE_IN_BODY_DOCS = NO
64 CASE_SENSE_NAMES = YES
66 SHOW_INCLUDE_FILES = YES
67 SHOW_GROUPED_MEMB_INC = NO
68 FORCE_LOCAL_INCLUDES = NO
70 SORT_MEMBER_DOCS = YES
72 SORT_MEMBERS_CTORS_1ST = NO
74 SORT_BY_SCOPE_NAME = NO
75 STRICT_PROTO_MATCHING = NO
76 GENERATE_TODOLIST = YES
77 GENERATE_TESTLIST = YES
78 GENERATE_BUGLIST = YES
79 GENERATE_DEPRECATEDLIST= YES
81 MAX_INITIALIZER_LINES = 30
88 #---------------------------------------------------------------------------
89 # Configuration options related to warning and progress messages
90 #---------------------------------------------------------------------------
93 WARN_IF_UNDOCUMENTED = YES
94 WARN_IF_DOC_ERROR = YES
96 WARN_FORMAT = "$file:$line: $text"
98 #---------------------------------------------------------------------------
99 # Configuration options related to the input files
100 #---------------------------------------------------------------------------
101 INPUT = "doxygen_index.h" \
102 "../lib/libcryptsetup.h"
103 INPUT_ENCODING = UTF-8
107 EXCLUDE_SYMLINKS = NO
110 EXAMPLE_PATH = "examples"
112 EXAMPLE_RECURSIVE = NO
116 FILTER_SOURCE_FILES = NO
117 FILTER_SOURCE_PATTERNS =
118 USE_MDFILE_AS_MAINPAGE =
119 #---------------------------------------------------------------------------
120 # Configuration options related to source browsing
121 #---------------------------------------------------------------------------
124 STRIP_CODE_COMMENTS = YES
125 REFERENCED_BY_RELATION = NO
126 REFERENCES_RELATION = NO
127 REFERENCES_LINK_SOURCE = YES
128 SOURCE_TOOLTIPS = YES
130 VERBATIM_HEADERS = YES
131 CLANG_ASSISTED_PARSING = NO
133 #---------------------------------------------------------------------------
134 # Configuration options related to the alphabetical class index
135 #---------------------------------------------------------------------------
136 ALPHABETICAL_INDEX = YES
137 COLS_IN_ALPHA_INDEX = 5
139 #---------------------------------------------------------------------------
140 # Configuration options related to the HTML output
141 #---------------------------------------------------------------------------
144 HTML_FILE_EXTENSION = .html
148 HTML_EXTRA_STYLESHEET =
150 HTML_COLORSTYLE_HUE = 220
151 HTML_COLORSTYLE_SAT = 100
152 HTML_COLORSTYLE_GAMMA = 80
154 HTML_DYNAMIC_SECTIONS = NO
155 HTML_INDEX_NUM_ENTRIES = 100
157 DOCSET_FEEDNAME = "Doxygen generated docs"
158 DOCSET_BUNDLE_ID = org.doxygen.Project
159 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
160 DOCSET_PUBLISHER_NAME = Publisher
161 GENERATE_HTMLHELP = NO
170 QHP_NAMESPACE = org.doxygen.Project
171 QHP_VIRTUAL_FOLDER = doc
172 QHP_CUST_FILTER_NAME =
173 QHP_CUST_FILTER_ATTRS =
174 QHP_SECT_FILTER_ATTRS =
176 GENERATE_ECLIPSEHELP = NO
177 ECLIPSE_DOC_ID = org.doxygen.Project
179 GENERATE_TREEVIEW = NO
180 ENUM_VALUES_PER_LINE = 4
182 EXT_LINKS_IN_WINDOW = NO
183 FORMULA_FONTSIZE = 10
184 FORMULA_TRANSPARENT = YES
186 MATHJAX_FORMAT = HTML-CSS
187 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
191 SERVER_BASED_SEARCH = NO
194 SEARCHDATA_FILE = searchdata.xml
196 EXTRA_SEARCH_MAPPINGS =
197 #---------------------------------------------------------------------------
198 # Configuration options related to the LaTeX output
199 #---------------------------------------------------------------------------
202 LATEX_CMD_NAME = latex
203 MAKEINDEX_CMD_NAME = makeindex
213 LATEX_HIDE_INDICES = NO
214 LATEX_SOURCE_CODE = NO
215 LATEX_BIB_STYLE = plain
216 #---------------------------------------------------------------------------
217 # Configuration options related to the RTF output
218 #---------------------------------------------------------------------------
223 RTF_STYLESHEET_FILE =
224 RTF_EXTENSIONS_FILE =
225 #---------------------------------------------------------------------------
226 # Configuration options related to the man page output
227 #---------------------------------------------------------------------------
233 #---------------------------------------------------------------------------
234 # Configuration options related to the XML output
235 #---------------------------------------------------------------------------
238 XML_PROGRAMLISTING = YES
239 #---------------------------------------------------------------------------
240 # Configuration options related to the DOCBOOK output
241 #---------------------------------------------------------------------------
242 GENERATE_DOCBOOK = NO
243 DOCBOOK_OUTPUT = docbook
244 DOCBOOK_PROGRAMLISTING = NO
245 #---------------------------------------------------------------------------
246 # Configuration options for the AutoGen Definitions output
247 #---------------------------------------------------------------------------
248 GENERATE_AUTOGEN_DEF = NO
249 #---------------------------------------------------------------------------
250 # Configuration options related to the Perl module output
251 #---------------------------------------------------------------------------
252 GENERATE_PERLMOD = NO
255 PERLMOD_MAKEVAR_PREFIX =
256 #---------------------------------------------------------------------------
257 # Configuration options related to the preprocessor
258 #---------------------------------------------------------------------------
259 ENABLE_PREPROCESSING = YES
261 EXPAND_ONLY_PREDEF = NO
262 SEARCH_INCLUDES = YES
264 INCLUDE_FILE_PATTERNS =
267 SKIP_FUNCTION_MACROS = YES
268 #---------------------------------------------------------------------------
269 # Configuration options related to external references
270 #---------------------------------------------------------------------------
274 EXTERNAL_GROUPS = YES
277 #---------------------------------------------------------------------------
278 # Configuration options related to the dot tool
279 #---------------------------------------------------------------------------
283 HIDE_UNDOC_RELATIONS = YES
286 DOT_FONTNAME = Helvetica
290 COLLABORATION_GRAPH = YES
293 UML_LIMIT_NUM_FIELDS = 10
294 TEMPLATE_RELATIONS = NO
296 INCLUDED_BY_GRAPH = YES
299 GRAPHICAL_HIERARCHY = YES
300 DIRECTORY_GRAPH = YES
301 DOT_IMAGE_FORMAT = png
308 DOT_GRAPH_MAX_NODES = 50
309 MAX_DOT_GRAPH_DEPTH = 0
311 DOT_MULTI_TARGETS = NO
312 GENERATE_LEGEND = YES