doc: clean up manpages
[notmuch] / doc / doxygen.cfg
1 # Doxyfile 1.8.4
2
3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING      = UTF-8
7 @INCLUDE               =  "doc/config.dox"
8 PROJECT_NUMBER         =
9 PROJECT_BRIEF          =
10 PROJECT_LOGO           =
11 OUTPUT_DIRECTORY       = doc/_build
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= YES
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_ENCODING         = UTF-8
100 FILE_PATTERNS          =
101 RECURSIVE              = NO
102 EXCLUDE                =
103 EXCLUDE_SYMLINKS       = NO
104 EXCLUDE_PATTERNS       =
105 EXCLUDE_SYMBOLS        =
106 EXAMPLE_PATH           =
107 EXAMPLE_PATTERNS       =
108 EXAMPLE_RECURSIVE      = NO
109 IMAGE_PATH             =
110 INPUT_FILTER           =
111 FILTER_PATTERNS        =
112 FILTER_SOURCE_FILES    = NO
113 FILTER_SOURCE_PATTERNS =
114 USE_MDFILE_AS_MAINPAGE =
115 #---------------------------------------------------------------------------
116 # configuration options related to source browsing
117 #---------------------------------------------------------------------------
118 SOURCE_BROWSER         = NO
119 INLINE_SOURCES         = NO
120 STRIP_CODE_COMMENTS    = YES
121 REFERENCED_BY_RELATION = NO
122 REFERENCES_RELATION    = NO
123 REFERENCES_LINK_SOURCE = YES
124 USE_HTAGS              = NO
125 VERBATIM_HEADERS       = NO
126 #---------------------------------------------------------------------------
127 # configuration options related to the alphabetical class index
128 #---------------------------------------------------------------------------
129 ALPHABETICAL_INDEX     = NO
130 COLS_IN_ALPHA_INDEX    = 5
131 IGNORE_PREFIX          =
132 #---------------------------------------------------------------------------
133 # configuration options related to the HTML output
134 #---------------------------------------------------------------------------
135 GENERATE_HTML          = NO
136 HTML_OUTPUT            = html
137 HTML_FILE_EXTENSION    = .html
138 HTML_HEADER            =
139 HTML_FOOTER            =
140 HTML_STYLESHEET        =
141 HTML_EXTRA_STYLESHEET  =
142 HTML_EXTRA_FILES       =
143 HTML_COLORSTYLE_HUE    = 220
144 HTML_COLORSTYLE_SAT    = 100
145 HTML_COLORSTYLE_GAMMA  = 80
146 HTML_TIMESTAMP         = YES
147 HTML_DYNAMIC_SECTIONS  = NO
148 HTML_INDEX_NUM_ENTRIES = 100
149 GENERATE_DOCSET        = NO
150 DOCSET_FEEDNAME        = "Doxygen generated docs"
151 DOCSET_BUNDLE_ID       = org.doxygen.Project
152 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
153 DOCSET_PUBLISHER_NAME  = Publisher
154 GENERATE_HTMLHELP      = NO
155 CHM_FILE               =
156 HHC_LOCATION           =
157 GENERATE_CHI           = NO
158 CHM_INDEX_ENCODING     =
159 BINARY_TOC             = NO
160 TOC_EXPAND             = NO
161 GENERATE_QHP           = NO
162 QCH_FILE               =
163 QHP_NAMESPACE          = org.doxygen.Project
164 QHP_VIRTUAL_FOLDER     = doc
165 QHP_CUST_FILTER_NAME   =
166 QHP_CUST_FILTER_ATTRS  =
167 QHP_SECT_FILTER_ATTRS  =
168 QHG_LOCATION           =
169 GENERATE_ECLIPSEHELP   = NO
170 ECLIPSE_DOC_ID         = org.doxygen.Project
171 DISABLE_INDEX          = NO
172 GENERATE_TREEVIEW      = NO
173 ENUM_VALUES_PER_LINE   = 4
174 TREEVIEW_WIDTH         = 250
175 EXT_LINKS_IN_WINDOW    = NO
176 FORMULA_FONTSIZE       = 10
177 FORMULA_TRANSPARENT    = YES
178 USE_MATHJAX            = NO
179 MATHJAX_FORMAT         = HTML-CSS
180 MATHJAX_RELPATH        = https://cdn.mathjax.org/mathjax/latest
181 MATHJAX_EXTENSIONS     =
182 MATHJAX_CODEFILE       =
183 SEARCHENGINE           = YES
184 SERVER_BASED_SEARCH    = NO
185 EXTERNAL_SEARCH        = NO
186 SEARCHENGINE_URL       =
187 SEARCHDATA_FILE        = searchdata.xml
188 EXTERNAL_SEARCH_ID     =
189 EXTRA_SEARCH_MAPPINGS  =
190 #---------------------------------------------------------------------------
191 # configuration options related to the LaTeX output
192 #---------------------------------------------------------------------------
193 GENERATE_LATEX         = NO
194 LATEX_OUTPUT           = latex
195 LATEX_CMD_NAME         = latex
196 MAKEINDEX_CMD_NAME     = makeindex
197 COMPACT_LATEX          = NO
198 PAPER_TYPE             = a4
199 EXTRA_PACKAGES         =
200 LATEX_HEADER           =
201 LATEX_FOOTER           =
202 LATEX_EXTRA_FILES      =
203 PDF_HYPERLINKS         = YES
204 USE_PDFLATEX           = YES
205 LATEX_BATCHMODE        = NO
206 LATEX_HIDE_INDICES     = NO
207 LATEX_SOURCE_CODE      = NO
208 LATEX_BIB_STYLE        = plain
209 #---------------------------------------------------------------------------
210 # configuration options related to the RTF output
211 #---------------------------------------------------------------------------
212 GENERATE_RTF           = NO
213 RTF_OUTPUT             = rtf
214 COMPACT_RTF            = NO
215 RTF_HYPERLINKS         = NO
216 RTF_STYLESHEET_FILE    =
217 RTF_EXTENSIONS_FILE    =
218 #---------------------------------------------------------------------------
219 # configuration options related to the man page output
220 #---------------------------------------------------------------------------
221 GENERATE_MAN           = YES
222 MAN_OUTPUT             = man
223 MAN_EXTENSION          = .3
224 MAN_LINKS              = NO
225 #---------------------------------------------------------------------------
226 # configuration options related to the XML output
227 #---------------------------------------------------------------------------
228 GENERATE_XML           = NO
229 XML_OUTPUT             = xml
230 XML_PROGRAMLISTING     = YES
231 #---------------------------------------------------------------------------
232 # configuration options related to the DOCBOOK output
233 #---------------------------------------------------------------------------
234 GENERATE_DOCBOOK       = NO
235 DOCBOOK_OUTPUT         = docbook
236 #---------------------------------------------------------------------------
237 # configuration options for the AutoGen Definitions output
238 #---------------------------------------------------------------------------
239 GENERATE_AUTOGEN_DEF   = NO
240 #---------------------------------------------------------------------------
241 # configuration options related to the Perl module output
242 #---------------------------------------------------------------------------
243 GENERATE_PERLMOD       = NO
244 PERLMOD_LATEX          = NO
245 PERLMOD_PRETTY         = YES
246 PERLMOD_MAKEVAR_PREFIX =
247 #---------------------------------------------------------------------------
248 # Configuration options related to the preprocessor
249 #---------------------------------------------------------------------------
250 ENABLE_PREPROCESSING   = YES
251 MACRO_EXPANSION        = NO
252 EXPAND_ONLY_PREDEF     = NO
253 SEARCH_INCLUDES        = NO
254 INCLUDE_PATH           =
255 INCLUDE_FILE_PATTERNS  =
256 PREDEFINED             = __DOXYGEN__
257 EXPAND_AS_DEFINED      =
258 SKIP_FUNCTION_MACROS   = YES
259 #---------------------------------------------------------------------------
260 # Configuration::additions related to external references
261 #---------------------------------------------------------------------------
262 TAGFILES               =
263 GENERATE_TAGFILE       =
264 ALLEXTERNALS           = NO
265 EXTERNAL_GROUPS        = NO
266 EXTERNAL_PAGES         = NO
267 PERL_PATH              = /usr/bin/perl
268 #---------------------------------------------------------------------------
269 # Configuration options related to the dot tool
270 #---------------------------------------------------------------------------
271 CLASS_DIAGRAMS         = NO
272 MSCGEN_PATH            =
273 HIDE_UNDOC_RELATIONS   = YES
274 HAVE_DOT               = NO
275 DOT_NUM_THREADS        = 0
276 DOT_FONTNAME           = Helvetica
277 DOT_FONTSIZE           = 10
278 DOT_FONTPATH           =
279 CLASS_GRAPH            = YES
280 COLLABORATION_GRAPH    = YES
281 GROUP_GRAPHS           = YES
282 UML_LOOK               = NO
283 UML_LIMIT_NUM_FIELDS   = 10
284 TEMPLATE_RELATIONS     = NO
285 INCLUDE_GRAPH          = NO
286 INCLUDED_BY_GRAPH      = NO
287 CALL_GRAPH             = NO
288 CALLER_GRAPH           = NO
289 GRAPHICAL_HIERARCHY    = NO
290 DIRECTORY_GRAPH        = NO
291 DOT_IMAGE_FORMAT       = png
292 INTERACTIVE_SVG        = NO
293 DOT_PATH               =
294 DOTFILE_DIRS           =
295 MSCFILE_DIRS           =
296 DOT_GRAPH_MAX_NODES    = 50
297 MAX_DOT_GRAPH_DEPTH    = 0
298 DOT_TRANSPARENT        = NO
299 DOT_MULTI_TARGETS      = YES
300 GENERATE_LEGEND        = NO
301 DOT_CLEANUP            = YES