]> git.notmuchmail.org Git - notmuch/blob - doc/doxygen.cfg
bfbfcab37c70f0c77c3f463d2b0d3df236e39251
[notmuch] / doc / doxygen.cfg
1 # Doxyfile 1.8.4
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 PROJECT_NAME           = "Notmuch 0.18"
8 PROJECT_NUMBER         =
9 PROJECT_BRIEF          =
10 PROJECT_LOGO           =
11 OUTPUT_DIRECTORY       =
12 CREATE_SUBDIRS         = NO
13 OUTPUT_LANGUAGE        = English
14 BRIEF_MEMBER_DESC      = YES
15 REPEAT_BRIEF           = YES
16 ABBREVIATE_BRIEF       =
17 ALWAYS_DETAILED_SEC    = NO
18 INLINE_INHERITED_MEMB  = NO
19 FULL_PATH_NAMES        = NO
20 STRIP_FROM_PATH        =
21 STRIP_FROM_INC_PATH    =
22 SHORT_NAMES            = NO
23 JAVADOC_AUTOBRIEF      = YES
24 QT_AUTOBRIEF           = NO
25 MULTILINE_CPP_IS_BRIEF = NO
26 INHERIT_DOCS           = YES
27 SEPARATE_MEMBER_PAGES  = NO
28 TAB_SIZE               = 8
29 ALIASES                =
30 TCL_SUBST              =
31 OPTIMIZE_OUTPUT_FOR_C  = YES
32 OPTIMIZE_OUTPUT_JAVA   = NO
33 OPTIMIZE_FOR_FORTRAN   = NO
34 OPTIMIZE_OUTPUT_VHDL   = NO
35 EXTENSION_MAPPING      =
36 MARKDOWN_SUPPORT       = YES
37 AUTOLINK_SUPPORT       = YES
38 BUILTIN_STL_SUPPORT    = NO
39 CPP_CLI_SUPPORT        = NO
40 SIP_SUPPORT            = NO
41 IDL_PROPERTY_SUPPORT   = YES
42 DISTRIBUTE_GROUP_DOC   = NO
43 SUBGROUPING            = YES
44 INLINE_GROUPED_CLASSES = NO
45 INLINE_SIMPLE_STRUCTS  = NO
46 TYPEDEF_HIDES_STRUCT   = YES
47 LOOKUP_CACHE_SIZE      = 0
48 #---------------------------------------------------------------------------
49 # Build related configuration options
50 #---------------------------------------------------------------------------
51 EXTRACT_ALL            = NO
52 EXTRACT_PRIVATE        = NO
53 EXTRACT_PACKAGE        = NO
54 EXTRACT_STATIC         = NO
55 EXTRACT_LOCAL_CLASSES  = YES
56 EXTRACT_LOCAL_METHODS  = NO
57 EXTRACT_ANON_NSPACES   = NO
58 HIDE_UNDOC_MEMBERS     = NO
59 HIDE_UNDOC_CLASSES     = NO
60 HIDE_FRIEND_COMPOUNDS  = NO
61 HIDE_IN_BODY_DOCS      = NO
62 INTERNAL_DOCS          = NO
63 CASE_SENSE_NAMES       = YES
64 HIDE_SCOPE_NAMES       = NO
65 SHOW_INCLUDE_FILES     = NO
66 FORCE_LOCAL_INCLUDES   = NO
67 INLINE_INFO            = YES
68 SORT_MEMBER_DOCS       = NO
69 SORT_BRIEF_DOCS        = NO
70 SORT_MEMBERS_CTORS_1ST = NO
71 SORT_GROUP_NAMES       = NO
72 SORT_BY_SCOPE_NAME     = NO
73 STRICT_PROTO_MATCHING  = NO
74 GENERATE_TODOLIST      = NO
75 GENERATE_TESTLIST      = NO
76 GENERATE_BUGLIST       = NO
77 GENERATE_DEPRECATEDLIST= NO
78 ENABLED_SECTIONS       =
79 MAX_INITIALIZER_LINES  = 30
80 SHOW_USED_FILES        = NO
81 SHOW_FILES             = NO
82 SHOW_NAMESPACES        = NO
83 FILE_VERSION_FILTER    =
84 LAYOUT_FILE            =
85 CITE_BIB_FILES         =
86 #---------------------------------------------------------------------------
87 # configuration options related to warning and progress messages
88 #---------------------------------------------------------------------------
89 QUIET                  = YES
90 WARNINGS               = YES
91 WARN_IF_UNDOCUMENTED   = YES
92 WARN_IF_DOC_ERROR      = YES
93 WARN_NO_PARAMDOC       = NO
94 WARN_FORMAT            = "$file:$line: $text"
95 WARN_LOGFILE           =
96 #---------------------------------------------------------------------------
97 # configuration options related to the input files
98 #---------------------------------------------------------------------------
99 INPUT                  = lib/notmuch.h
100 INPUT_ENCODING         = UTF-8
101 FILE_PATTERNS          =
102 RECURSIVE              = NO
103 EXCLUDE                =
104 EXCLUDE_SYMLINKS       = NO
105 EXCLUDE_PATTERNS       =
106 EXCLUDE_SYMBOLS        =
107 EXAMPLE_PATH           =
108 EXAMPLE_PATTERNS       =
109 EXAMPLE_RECURSIVE      = NO
110 IMAGE_PATH             =
111 INPUT_FILTER           =
112 FILTER_PATTERNS        =
113 FILTER_SOURCE_FILES    = NO
114 FILTER_SOURCE_PATTERNS =
115 USE_MDFILE_AS_MAINPAGE =
116 #---------------------------------------------------------------------------
117 # configuration options related to source browsing
118 #---------------------------------------------------------------------------
119 SOURCE_BROWSER         = NO
120 INLINE_SOURCES         = NO
121 STRIP_CODE_COMMENTS    = YES
122 REFERENCED_BY_RELATION = NO
123 REFERENCES_RELATION    = NO
124 REFERENCES_LINK_SOURCE = YES
125 USE_HTAGS              = NO
126 VERBATIM_HEADERS       = NO
127 #---------------------------------------------------------------------------
128 # configuration options related to the alphabetical class index
129 #---------------------------------------------------------------------------
130 ALPHABETICAL_INDEX     = NO
131 COLS_IN_ALPHA_INDEX    = 5
132 IGNORE_PREFIX          =
133 #---------------------------------------------------------------------------
134 # configuration options related to the HTML output
135 #---------------------------------------------------------------------------
136 GENERATE_HTML          = NO
137 HTML_OUTPUT            = html
138 HTML_FILE_EXTENSION    = .html
139 HTML_HEADER            =
140 HTML_FOOTER            =
141 HTML_STYLESHEET        =
142 HTML_EXTRA_STYLESHEET  =
143 HTML_EXTRA_FILES       =
144 HTML_COLORSTYLE_HUE    = 220
145 HTML_COLORSTYLE_SAT    = 100
146 HTML_COLORSTYLE_GAMMA  = 80
147 HTML_TIMESTAMP         = YES
148 HTML_DYNAMIC_SECTIONS  = NO
149 HTML_INDEX_NUM_ENTRIES = 100
150 GENERATE_DOCSET        = NO
151 DOCSET_FEEDNAME        = "Doxygen generated docs"
152 DOCSET_BUNDLE_ID       = org.doxygen.Project
153 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
154 DOCSET_PUBLISHER_NAME  = Publisher
155 GENERATE_HTMLHELP      = NO
156 CHM_FILE               =
157 HHC_LOCATION           =
158 GENERATE_CHI           = NO
159 CHM_INDEX_ENCODING     =
160 BINARY_TOC             = NO
161 TOC_EXPAND             = NO
162 GENERATE_QHP           = NO
163 QCH_FILE               =
164 QHP_NAMESPACE          = org.doxygen.Project
165 QHP_VIRTUAL_FOLDER     = doc
166 QHP_CUST_FILTER_NAME   =
167 QHP_CUST_FILTER_ATTRS  =
168 QHP_SECT_FILTER_ATTRS  =
169 QHG_LOCATION           =
170 GENERATE_ECLIPSEHELP   = NO
171 ECLIPSE_DOC_ID         = org.doxygen.Project
172 DISABLE_INDEX          = NO
173 GENERATE_TREEVIEW      = NO
174 ENUM_VALUES_PER_LINE   = 4
175 TREEVIEW_WIDTH         = 250
176 EXT_LINKS_IN_WINDOW    = NO
177 FORMULA_FONTSIZE       = 10
178 FORMULA_TRANSPARENT    = YES
179 USE_MATHJAX            = NO
180 MATHJAX_FORMAT         = HTML-CSS
181 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
182 MATHJAX_EXTENSIONS     =
183 MATHJAX_CODEFILE       =
184 SEARCHENGINE           = YES
185 SERVER_BASED_SEARCH    = NO
186 EXTERNAL_SEARCH        = NO
187 SEARCHENGINE_URL       =
188 SEARCHDATA_FILE        = searchdata.xml
189 EXTERNAL_SEARCH_ID     =
190 EXTRA_SEARCH_MAPPINGS  =
191 #---------------------------------------------------------------------------
192 # configuration options related to the LaTeX output
193 #---------------------------------------------------------------------------
194 GENERATE_LATEX         = NO
195 LATEX_OUTPUT           = latex
196 LATEX_CMD_NAME         = latex
197 MAKEINDEX_CMD_NAME     = makeindex
198 COMPACT_LATEX          = NO
199 PAPER_TYPE             = a4
200 EXTRA_PACKAGES         =
201 LATEX_HEADER           =
202 LATEX_FOOTER           =
203 LATEX_EXTRA_FILES      =
204 PDF_HYPERLINKS         = YES
205 USE_PDFLATEX           = YES
206 LATEX_BATCHMODE        = NO
207 LATEX_HIDE_INDICES     = NO
208 LATEX_SOURCE_CODE      = NO
209 LATEX_BIB_STYLE        = plain
210 #---------------------------------------------------------------------------
211 # configuration options related to the RTF output
212 #---------------------------------------------------------------------------
213 GENERATE_RTF           = NO
214 RTF_OUTPUT             = rtf
215 COMPACT_RTF            = NO
216 RTF_HYPERLINKS         = NO
217 RTF_STYLESHEET_FILE    =
218 RTF_EXTENSIONS_FILE    =
219 #---------------------------------------------------------------------------
220 # configuration options related to the man page output
221 #---------------------------------------------------------------------------
222 GENERATE_MAN           = YES
223 MAN_OUTPUT             = man
224 MAN_EXTENSION          = .3
225 MAN_LINKS              = NO
226 #---------------------------------------------------------------------------
227 # configuration options related to the XML output
228 #---------------------------------------------------------------------------
229 GENERATE_XML           = NO
230 XML_OUTPUT             = xml
231 XML_SCHEMA             =
232 XML_DTD                =
233 XML_PROGRAMLISTING     = YES
234 #---------------------------------------------------------------------------
235 # configuration options related to the DOCBOOK output
236 #---------------------------------------------------------------------------
237 GENERATE_DOCBOOK       = NO
238 DOCBOOK_OUTPUT         = docbook
239 #---------------------------------------------------------------------------
240 # configuration options for the AutoGen Definitions output
241 #---------------------------------------------------------------------------
242 GENERATE_AUTOGEN_DEF   = NO
243 #---------------------------------------------------------------------------
244 # configuration options related to the Perl module output
245 #---------------------------------------------------------------------------
246 GENERATE_PERLMOD       = NO
247 PERLMOD_LATEX          = NO
248 PERLMOD_PRETTY         = YES
249 PERLMOD_MAKEVAR_PREFIX =
250 #---------------------------------------------------------------------------
251 # Configuration options related to the preprocessor
252 #---------------------------------------------------------------------------
253 ENABLE_PREPROCESSING   = YES
254 MACRO_EXPANSION        = NO
255 EXPAND_ONLY_PREDEF     = NO
256 SEARCH_INCLUDES        = NO
257 INCLUDE_PATH           =
258 INCLUDE_FILE_PATTERNS  =
259 PREDEFINED             = __DOXYGEN__
260 EXPAND_AS_DEFINED      =
261 SKIP_FUNCTION_MACROS   = YES
262 #---------------------------------------------------------------------------
263 # Configuration::additions related to external references
264 #---------------------------------------------------------------------------
265 TAGFILES               =
266 GENERATE_TAGFILE       =
267 ALLEXTERNALS           = NO
268 EXTERNAL_GROUPS        = NO
269 EXTERNAL_PAGES         = NO
270 PERL_PATH              = /usr/bin/perl
271 #---------------------------------------------------------------------------
272 # Configuration options related to the dot tool
273 #---------------------------------------------------------------------------
274 CLASS_DIAGRAMS         = NO
275 MSCGEN_PATH            =
276 HIDE_UNDOC_RELATIONS   = YES
277 HAVE_DOT               = NO
278 DOT_NUM_THREADS        = 0
279 DOT_FONTNAME           = Helvetica
280 DOT_FONTSIZE           = 10
281 DOT_FONTPATH           =
282 CLASS_GRAPH            = YES
283 COLLABORATION_GRAPH    = YES
284 GROUP_GRAPHS           = YES
285 UML_LOOK               = NO
286 UML_LIMIT_NUM_FIELDS   = 10
287 TEMPLATE_RELATIONS     = NO
288 INCLUDE_GRAPH          = NO
289 INCLUDED_BY_GRAPH      = NO
290 CALL_GRAPH             = NO
291 CALLER_GRAPH           = NO
292 GRAPHICAL_HIERARCHY    = NO
293 DIRECTORY_GRAPH        = NO
294 DOT_IMAGE_FORMAT       = png
295 INTERACTIVE_SVG        = NO
296 DOT_PATH               =
297 DOTFILE_DIRS           =
298 MSCFILE_DIRS           =
299 DOT_GRAPH_MAX_NODES    = 50
300 MAX_DOT_GRAPH_DEPTH    = 0
301 DOT_TRANSPARENT        = NO
302 DOT_MULTI_TARGETS      = YES
303 GENERATE_LEGEND        = NO
304 DOT_CLEANUP            = YES