1 Return-Path: <jani@nikula.org>
\r
2 X-Original-To: notmuch@notmuchmail.org
\r
3 Delivered-To: notmuch@notmuchmail.org
\r
4 Received: from localhost (localhost [127.0.0.1])
\r
5 by olra.theworths.org (Postfix) with ESMTP id B5D23431FAF
\r
6 for <notmuch@notmuchmail.org>; Wed, 1 Jan 2014 09:53:06 -0800 (PST)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
8 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"
\r
12 X-Spam-Status: No, score=0.091 tagged_above=-999 required=5
\r
13 tests=[RCVD_IN_DNSWL_LOW=-0.7, UPPERCASE_50_75=0.791]
\r
15 Received: from olra.theworths.org ([127.0.0.1])
\r
16 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
17 with ESMTP id thxkUtxhc3qb for <notmuch@notmuchmail.org>;
\r
18 Wed, 1 Jan 2014 09:53:01 -0800 (PST)
\r
19 Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com
\r
20 [74.125.83.41]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client
\r
21 certificate requested) by olra.theworths.org (Postfix) with ESMTPS id
\r
22 6F515431FC0 for <notmuch@notmuchmail.org>; Wed, 1 Jan 2014 09:53:01 -0800
\r
24 Received: by mail-ee0-f41.google.com with SMTP id t10so5986929eei.14
\r
25 for <notmuch@notmuchmail.org>; Wed, 01 Jan 2014 09:53:00 -0800 (PST)
\r
26 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
\r
27 d=1e100.net; s=20130820;
\r
28 h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
\r
29 :references:in-reply-to:references;
\r
30 bh=uTrEEWh9XeNMAolYs9+odOqJWi9HQCa7qvCxWzl69BQ=;
\r
31 b=MJGRfRWuut8htA7w5/vNsivJKIff3t3s1WXDnXC6IUYVU0z4onuu6oQmbgZ/CiUnJJ
\r
32 IrFtT7U5qh2N93FRHVMqzUAV9bJDMpbNzYxgTnX9uQoVYIPetFYNUiNxnOIlf+oOTM/h
\r
33 VNiuM+0oTbAr3Lw+mdrhdaf5n+DF0N+hU8Y53bEgESqlqPqEmLAK2xYm3azc+cVViyYC
\r
34 ATbN6m9Q4Y19pboC7gBBUNsT68iboYn8fLvo+7s6WynZ1X1c1QNX4kl+IzBYt1G18k12
\r
35 qlcCFQqu3RESVt+XvRZQh5hjOZ+G09Z3SXXqMDcQaTaDTb+jEYYiTa9IIsXUBfzUttRB
\r
38 ALoCoQmV/F50M0ZkwkUUmm9UHnETSSza6L7SWgwi6WqI5AK6kDNm8se+ArCfXyFNyzdLQgmoPWc1
\r
39 X-Received: by 10.14.99.129 with SMTP id x1mr12010514eef.89.1388598780038;
\r
40 Wed, 01 Jan 2014 09:53:00 -0800 (PST)
\r
41 Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.
\r
42 [88.195.111.91]) by mx.google.com with ESMTPSA id
\r
43 g47sm128879006eeo.19.2014.01.01.09.52.58 for <multiple recipients>
\r
44 (version=TLSv1.2 cipher=RC4-SHA bits=128/128);
\r
45 Wed, 01 Jan 2014 09:52:59 -0800 (PST)
\r
46 From: Jani Nikula <jani@nikula.org>
\r
47 To: notmuch@notmuchmail.org
\r
48 Subject: [PATCH v2 1/2] devel: add doxygen configuration file
\r
49 Date: Wed, 1 Jan 2014 19:52:53 +0200
\r
51 <f23ce4902a0d7a6351874457ae2344074ac405ad.1388598677.git.jani@nikula.org>
\r
52 X-Mailer: git-send-email 1.8.5.2
\r
53 In-Reply-To: <cover.1388598677.git.jani@nikula.org>
\r
54 References: <cover.1388598677.git.jani@nikula.org>
\r
55 In-Reply-To: <cover.1388598677.git.jani@nikula.org>
\r
56 References: <cover.1388598677.git.jani@nikula.org>
\r
57 X-BeenThere: notmuch@notmuchmail.org
\r
58 X-Mailman-Version: 2.1.13
\r
60 List-Id: "Use and development of the notmuch mail system."
\r
61 <notmuch.notmuchmail.org>
\r
62 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
63 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
64 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
65 List-Post: <mailto:notmuch@notmuchmail.org>
\r
66 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
67 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
68 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
69 X-List-Received-Date: Wed, 01 Jan 2014 17:53:06 -0000
\r
71 This is a pretty basic config to get started, generated using 'doxygen
\r
72 -s -g' and mildly tweaked.
\r
74 To generate the library man page man/man3/notmuch.3 from lib/notmuch.h
\r
77 $ doxygen devel/doxygen.cfg
\r
79 devel/doxygen.cfg | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
\r
80 1 file changed, 304 insertions(+)
\r
81 create mode 100644 devel/doxygen.cfg
\r
83 diff --git a/devel/doxygen.cfg b/devel/doxygen.cfg
\r
84 new file mode 100644
\r
85 index 0000000..65d5fb5
\r
87 +++ b/devel/doxygen.cfg
\r
91 +#---------------------------------------------------------------------------
\r
92 +# Project related configuration options
\r
93 +#---------------------------------------------------------------------------
\r
94 +DOXYFILE_ENCODING = UTF-8
\r
95 +PROJECT_NAME = "Notmuch 0.17"
\r
100 +CREATE_SUBDIRS = NO
\r
101 +OUTPUT_LANGUAGE = English
\r
102 +BRIEF_MEMBER_DESC = YES
\r
103 +REPEAT_BRIEF = YES
\r
104 +ABBREVIATE_BRIEF =
\r
105 +ALWAYS_DETAILED_SEC = NO
\r
106 +INLINE_INHERITED_MEMB = NO
\r
107 +FULL_PATH_NAMES = NO
\r
109 +STRIP_FROM_INC_PATH =
\r
111 +JAVADOC_AUTOBRIEF = YES
\r
113 +MULTILINE_CPP_IS_BRIEF = NO
\r
114 +INHERIT_DOCS = YES
\r
115 +SEPARATE_MEMBER_PAGES = NO
\r
119 +OPTIMIZE_OUTPUT_FOR_C = YES
\r
120 +OPTIMIZE_OUTPUT_JAVA = NO
\r
121 +OPTIMIZE_FOR_FORTRAN = NO
\r
122 +OPTIMIZE_OUTPUT_VHDL = NO
\r
123 +EXTENSION_MAPPING =
\r
124 +MARKDOWN_SUPPORT = YES
\r
125 +AUTOLINK_SUPPORT = YES
\r
126 +BUILTIN_STL_SUPPORT = NO
\r
127 +CPP_CLI_SUPPORT = NO
\r
129 +IDL_PROPERTY_SUPPORT = YES
\r
130 +DISTRIBUTE_GROUP_DOC = NO
\r
132 +INLINE_GROUPED_CLASSES = NO
\r
133 +INLINE_SIMPLE_STRUCTS = NO
\r
134 +TYPEDEF_HIDES_STRUCT = YES
\r
135 +LOOKUP_CACHE_SIZE = 0
\r
136 +#---------------------------------------------------------------------------
\r
137 +# Build related configuration options
\r
138 +#---------------------------------------------------------------------------
\r
140 +EXTRACT_PRIVATE = NO
\r
141 +EXTRACT_PACKAGE = NO
\r
142 +EXTRACT_STATIC = NO
\r
143 +EXTRACT_LOCAL_CLASSES = YES
\r
144 +EXTRACT_LOCAL_METHODS = NO
\r
145 +EXTRACT_ANON_NSPACES = NO
\r
146 +HIDE_UNDOC_MEMBERS = NO
\r
147 +HIDE_UNDOC_CLASSES = NO
\r
148 +HIDE_FRIEND_COMPOUNDS = NO
\r
149 +HIDE_IN_BODY_DOCS = NO
\r
150 +INTERNAL_DOCS = NO
\r
151 +CASE_SENSE_NAMES = YES
\r
152 +HIDE_SCOPE_NAMES = NO
\r
153 +SHOW_INCLUDE_FILES = NO
\r
154 +FORCE_LOCAL_INCLUDES = NO
\r
156 +SORT_MEMBER_DOCS = NO
\r
157 +SORT_BRIEF_DOCS = NO
\r
158 +SORT_MEMBERS_CTORS_1ST = NO
\r
159 +SORT_GROUP_NAMES = NO
\r
160 +SORT_BY_SCOPE_NAME = NO
\r
161 +STRICT_PROTO_MATCHING = NO
\r
162 +GENERATE_TODOLIST = NO
\r
163 +GENERATE_TESTLIST = NO
\r
164 +GENERATE_BUGLIST = NO
\r
165 +GENERATE_DEPRECATEDLIST= NO
\r
166 +ENABLED_SECTIONS =
\r
167 +MAX_INITIALIZER_LINES = 30
\r
168 +SHOW_USED_FILES = NO
\r
170 +SHOW_NAMESPACES = NO
\r
171 +FILE_VERSION_FILTER =
\r
174 +#---------------------------------------------------------------------------
\r
175 +# configuration options related to warning and progress messages
\r
176 +#---------------------------------------------------------------------------
\r
179 +WARN_IF_UNDOCUMENTED = YES
\r
180 +WARN_IF_DOC_ERROR = YES
\r
181 +WARN_NO_PARAMDOC = NO
\r
182 +WARN_FORMAT = "$file:$line: $text"
\r
184 +#---------------------------------------------------------------------------
\r
185 +# configuration options related to the input files
\r
186 +#---------------------------------------------------------------------------
\r
187 +INPUT = lib/notmuch.h
\r
188 +INPUT_ENCODING = UTF-8
\r
192 +EXCLUDE_SYMLINKS = NO
\r
193 +EXCLUDE_PATTERNS =
\r
196 +EXAMPLE_PATTERNS =
\r
197 +EXAMPLE_RECURSIVE = NO
\r
201 +FILTER_SOURCE_FILES = NO
\r
202 +FILTER_SOURCE_PATTERNS =
\r
203 +USE_MDFILE_AS_MAINPAGE =
\r
204 +#---------------------------------------------------------------------------
\r
205 +# configuration options related to source browsing
\r
206 +#---------------------------------------------------------------------------
\r
207 +SOURCE_BROWSER = NO
\r
208 +INLINE_SOURCES = NO
\r
209 +STRIP_CODE_COMMENTS = YES
\r
210 +REFERENCED_BY_RELATION = NO
\r
211 +REFERENCES_RELATION = NO
\r
212 +REFERENCES_LINK_SOURCE = YES
\r
214 +VERBATIM_HEADERS = NO
\r
215 +#---------------------------------------------------------------------------
\r
216 +# configuration options related to the alphabetical class index
\r
217 +#---------------------------------------------------------------------------
\r
218 +ALPHABETICAL_INDEX = NO
\r
219 +COLS_IN_ALPHA_INDEX = 5
\r
221 +#---------------------------------------------------------------------------
\r
222 +# configuration options related to the HTML output
\r
223 +#---------------------------------------------------------------------------
\r
224 +GENERATE_HTML = NO
\r
225 +HTML_OUTPUT = html
\r
226 +HTML_FILE_EXTENSION = .html
\r
230 +HTML_EXTRA_STYLESHEET =
\r
231 +HTML_EXTRA_FILES =
\r
232 +HTML_COLORSTYLE_HUE = 220
\r
233 +HTML_COLORSTYLE_SAT = 100
\r
234 +HTML_COLORSTYLE_GAMMA = 80
\r
235 +HTML_TIMESTAMP = YES
\r
236 +HTML_DYNAMIC_SECTIONS = NO
\r
237 +HTML_INDEX_NUM_ENTRIES = 100
\r
238 +GENERATE_DOCSET = NO
\r
239 +DOCSET_FEEDNAME = "Doxygen generated docs"
\r
240 +DOCSET_BUNDLE_ID = org.doxygen.Project
\r
241 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
\r
242 +DOCSET_PUBLISHER_NAME = Publisher
\r
243 +GENERATE_HTMLHELP = NO
\r
247 +CHM_INDEX_ENCODING =
\r
252 +QHP_NAMESPACE = org.doxygen.Project
\r
253 +QHP_VIRTUAL_FOLDER = doc
\r
254 +QHP_CUST_FILTER_NAME =
\r
255 +QHP_CUST_FILTER_ATTRS =
\r
256 +QHP_SECT_FILTER_ATTRS =
\r
258 +GENERATE_ECLIPSEHELP = NO
\r
259 +ECLIPSE_DOC_ID = org.doxygen.Project
\r
260 +DISABLE_INDEX = NO
\r
261 +GENERATE_TREEVIEW = NO
\r
262 +ENUM_VALUES_PER_LINE = 4
\r
263 +TREEVIEW_WIDTH = 250
\r
264 +EXT_LINKS_IN_WINDOW = NO
\r
265 +FORMULA_FONTSIZE = 10
\r
266 +FORMULA_TRANSPARENT = YES
\r
268 +MATHJAX_FORMAT = HTML-CSS
\r
269 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
\r
270 +MATHJAX_EXTENSIONS =
\r
271 +MATHJAX_CODEFILE =
\r
272 +SEARCHENGINE = YES
\r
273 +SERVER_BASED_SEARCH = NO
\r
274 +EXTERNAL_SEARCH = NO
\r
275 +SEARCHENGINE_URL =
\r
276 +SEARCHDATA_FILE = searchdata.xml
\r
277 +EXTERNAL_SEARCH_ID =
\r
278 +EXTRA_SEARCH_MAPPINGS =
\r
279 +#---------------------------------------------------------------------------
\r
280 +# configuration options related to the LaTeX output
\r
281 +#---------------------------------------------------------------------------
\r
282 +GENERATE_LATEX = NO
\r
283 +LATEX_OUTPUT = latex
\r
284 +LATEX_CMD_NAME = latex
\r
285 +MAKEINDEX_CMD_NAME = makeindex
\r
286 +COMPACT_LATEX = NO
\r
291 +LATEX_EXTRA_FILES =
\r
292 +PDF_HYPERLINKS = YES
\r
293 +USE_PDFLATEX = YES
\r
294 +LATEX_BATCHMODE = NO
\r
295 +LATEX_HIDE_INDICES = NO
\r
296 +LATEX_SOURCE_CODE = NO
\r
297 +LATEX_BIB_STYLE = plain
\r
298 +#---------------------------------------------------------------------------
\r
299 +# configuration options related to the RTF output
\r
300 +#---------------------------------------------------------------------------
\r
304 +RTF_HYPERLINKS = NO
\r
305 +RTF_STYLESHEET_FILE =
\r
306 +RTF_EXTENSIONS_FILE =
\r
307 +#---------------------------------------------------------------------------
\r
308 +# configuration options related to the man page output
\r
309 +#---------------------------------------------------------------------------
\r
310 +GENERATE_MAN = YES
\r
312 +MAN_EXTENSION = .3
\r
314 +#---------------------------------------------------------------------------
\r
315 +# configuration options related to the XML output
\r
316 +#---------------------------------------------------------------------------
\r
321 +XML_PROGRAMLISTING = YES
\r
322 +#---------------------------------------------------------------------------
\r
323 +# configuration options related to the DOCBOOK output
\r
324 +#---------------------------------------------------------------------------
\r
325 +GENERATE_DOCBOOK = NO
\r
326 +DOCBOOK_OUTPUT = docbook
\r
327 +#---------------------------------------------------------------------------
\r
328 +# configuration options for the AutoGen Definitions output
\r
329 +#---------------------------------------------------------------------------
\r
330 +GENERATE_AUTOGEN_DEF = NO
\r
331 +#---------------------------------------------------------------------------
\r
332 +# configuration options related to the Perl module output
\r
333 +#---------------------------------------------------------------------------
\r
334 +GENERATE_PERLMOD = NO
\r
335 +PERLMOD_LATEX = NO
\r
336 +PERLMOD_PRETTY = YES
\r
337 +PERLMOD_MAKEVAR_PREFIX =
\r
338 +#---------------------------------------------------------------------------
\r
339 +# Configuration options related to the preprocessor
\r
340 +#---------------------------------------------------------------------------
\r
341 +ENABLE_PREPROCESSING = YES
\r
342 +MACRO_EXPANSION = NO
\r
343 +EXPAND_ONLY_PREDEF = NO
\r
344 +SEARCH_INCLUDES = NO
\r
346 +INCLUDE_FILE_PATTERNS =
\r
347 +PREDEFINED = __DOXYGEN__
\r
348 +EXPAND_AS_DEFINED =
\r
349 +SKIP_FUNCTION_MACROS = YES
\r
350 +#---------------------------------------------------------------------------
\r
351 +# Configuration::additions related to external references
\r
352 +#---------------------------------------------------------------------------
\r
354 +GENERATE_TAGFILE =
\r
356 +EXTERNAL_GROUPS = NO
\r
357 +EXTERNAL_PAGES = NO
\r
358 +PERL_PATH = /usr/bin/perl
\r
359 +#---------------------------------------------------------------------------
\r
360 +# Configuration options related to the dot tool
\r
361 +#---------------------------------------------------------------------------
\r
362 +CLASS_DIAGRAMS = NO
\r
364 +HIDE_UNDOC_RELATIONS = YES
\r
366 +DOT_NUM_THREADS = 0
\r
367 +DOT_FONTNAME = Helvetica
\r
371 +COLLABORATION_GRAPH = YES
\r
372 +GROUP_GRAPHS = YES
\r
374 +UML_LIMIT_NUM_FIELDS = 10
\r
375 +TEMPLATE_RELATIONS = NO
\r
376 +INCLUDE_GRAPH = NO
\r
377 +INCLUDED_BY_GRAPH = NO
\r
380 +GRAPHICAL_HIERARCHY = NO
\r
381 +DIRECTORY_GRAPH = NO
\r
382 +DOT_IMAGE_FORMAT = png
\r
383 +INTERACTIVE_SVG = NO
\r
387 +DOT_GRAPH_MAX_NODES = 50
\r
388 +MAX_DOT_GRAPH_DEPTH = 0
\r
389 +DOT_TRANSPARENT = NO
\r
390 +DOT_MULTI_TARGETS = YES
\r
391 +GENERATE_LEGEND = NO
\r