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 A0101431FDC
\r
6 for <notmuch@notmuchmail.org>; Sun, 1 Dec 2013 02:03:48 -0800 (PST)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
11 X-Spam-Status: No, score=0.091 tagged_above=-999 required=5
\r
12 tests=[RCVD_IN_DNSWL_LOW=-0.7, UPPERCASE_50_75=0.791]
\r
14 Received: from olra.theworths.org ([127.0.0.1])
\r
15 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
16 with ESMTP id U3IVs8u7a32B for <notmuch@notmuchmail.org>;
\r
17 Sun, 1 Dec 2013 02:03:38 -0800 (PST)
\r
18 Received: from mail-ea0-f182.google.com (mail-ea0-f182.google.com
\r
19 [209.85.215.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
\r
20 (No client certificate requested)
\r
21 by olra.theworths.org (Postfix) with ESMTPS id 6FB92431FD0
\r
22 for <notmuch@notmuchmail.org>; Sun, 1 Dec 2013 02:03:38 -0800 (PST)
\r
23 Received: by mail-ea0-f182.google.com with SMTP id o10so11195158eaj.27
\r
24 for <notmuch@notmuchmail.org>; Sun, 01 Dec 2013 02:03:37 -0800 (PST)
\r
25 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
\r
26 d=1e100.net; s=20130820;
\r
27 h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
\r
29 bh=DrDwJmqltKj6RVws8MiBiswPTh4a9F/wEhpnxX0EMPY=;
\r
30 b=jCHwFFD2URcLc6OaNciwUWitDncwVYtt+m3aNiH13E54WPW09o9FakUC2MWGf/hM5e
\r
31 BdL23gYHYndmJworU4RJSHRkK96+SU9/PJWp4o0bcZZ1ir6gA9lNkwXYmcl7tQymkutG
\r
32 YASPh/OX36+67jBwFKe6p+2PHshnP2eOFvmQRKEF83DysJ2hj6B3/27KC4CCjQT3zVlu
\r
33 SMN3BqV7qeZ3v7HDzg9LxSGalwcp/9T7+u35SFOYCTjB9aVVAa18Ziuwt4aBvJd7RTHs
\r
34 2xYkVGEErwgLzKy20EALZLnRJapNsxnWzqExPtyaFSQSMvad800lotANr8Yy6XvJ4AK9
\r
37 ALoCoQntcGpFl/9/Ay/fRtOo2q0sKWuwugBKdCNtsz07qyyCEMZIsWM29OQ2cr9UqeTpkPznjE5l
\r
38 X-Received: by 10.15.50.195 with SMTP id l43mr60501400eew.30.1385890767997;
\r
39 Sun, 01 Dec 2013 01:39:27 -0800 (PST)
\r
40 Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.
\r
42 by mx.google.com with ESMTPSA id l4sm23394788een.13.2013.12.01.01.39.26
\r
43 for <multiple recipients>
\r
44 (version=TLSv1.2 cipher=RC4-SHA bits=128/128);
\r
45 Sun, 01 Dec 2013 01:39:26 -0800 (PST)
\r
46 From: Jani Nikula <jani@nikula.org>
\r
47 To: notmuch@notmuchmail.org
\r
48 Subject: [PATCH] devel: add doxygen configuration file
\r
49 Date: Sun, 1 Dec 2013 11:39:23 +0200
\r
50 Message-Id: <1385890763-15161-1-git-send-email-jani@nikula.org>
\r
51 X-Mailer: git-send-email 1.8.4.2
\r
53 <4000d64d9fa9e0954ace15dcdf97f1a39b6b6145.1385826040.git.jani@nikula.org>
\r
55 <4000d64d9fa9e0954ace15dcdf97f1a39b6b6145.1385826040.git.jani@nikula.org>
\r
56 X-BeenThere: notmuch@notmuchmail.org
\r
57 X-Mailman-Version: 2.1.13
\r
59 List-Id: "Use and development of the notmuch mail system."
\r
60 <notmuch.notmuchmail.org>
\r
61 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
62 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
63 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
64 List-Post: <mailto:notmuch@notmuchmail.org>
\r
65 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
66 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
67 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
68 X-List-Received-Date: Sun, 01 Dec 2013 10:03:48 -0000
\r
70 To generate library man page from lib/notmuch.h using
\r
72 $ doxygen devel/doxygen.cfg
\r
76 Same as before but with comments removed using:
\r
77 $ doxygen -s -u devel/doxygen.cfg
\r
79 You can get the comments back with:
\r
80 $ doxygen -u devel/doxygen.cfg
\r
82 Removing the explicitly set defaults or unused config options requires
\r
85 devel/doxygen.cfg | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
\r
86 1 file changed, 304 insertions(+)
\r
87 create mode 100644 devel/doxygen.cfg
\r
89 diff --git a/devel/doxygen.cfg b/devel/doxygen.cfg
\r
90 new file mode 100644
\r
91 index 0000000..65d5fb5
\r
93 +++ b/devel/doxygen.cfg
\r
97 +#---------------------------------------------------------------------------
\r
98 +# Project related configuration options
\r
99 +#---------------------------------------------------------------------------
\r
100 +DOXYFILE_ENCODING = UTF-8
\r
101 +PROJECT_NAME = "Notmuch 0.17"
\r
105 +OUTPUT_DIRECTORY =
\r
106 +CREATE_SUBDIRS = NO
\r
107 +OUTPUT_LANGUAGE = English
\r
108 +BRIEF_MEMBER_DESC = YES
\r
109 +REPEAT_BRIEF = YES
\r
110 +ABBREVIATE_BRIEF =
\r
111 +ALWAYS_DETAILED_SEC = NO
\r
112 +INLINE_INHERITED_MEMB = NO
\r
113 +FULL_PATH_NAMES = NO
\r
115 +STRIP_FROM_INC_PATH =
\r
117 +JAVADOC_AUTOBRIEF = YES
\r
119 +MULTILINE_CPP_IS_BRIEF = NO
\r
120 +INHERIT_DOCS = YES
\r
121 +SEPARATE_MEMBER_PAGES = NO
\r
125 +OPTIMIZE_OUTPUT_FOR_C = YES
\r
126 +OPTIMIZE_OUTPUT_JAVA = NO
\r
127 +OPTIMIZE_FOR_FORTRAN = NO
\r
128 +OPTIMIZE_OUTPUT_VHDL = NO
\r
129 +EXTENSION_MAPPING =
\r
130 +MARKDOWN_SUPPORT = YES
\r
131 +AUTOLINK_SUPPORT = YES
\r
132 +BUILTIN_STL_SUPPORT = NO
\r
133 +CPP_CLI_SUPPORT = NO
\r
135 +IDL_PROPERTY_SUPPORT = YES
\r
136 +DISTRIBUTE_GROUP_DOC = NO
\r
138 +INLINE_GROUPED_CLASSES = NO
\r
139 +INLINE_SIMPLE_STRUCTS = NO
\r
140 +TYPEDEF_HIDES_STRUCT = YES
\r
141 +LOOKUP_CACHE_SIZE = 0
\r
142 +#---------------------------------------------------------------------------
\r
143 +# Build related configuration options
\r
144 +#---------------------------------------------------------------------------
\r
146 +EXTRACT_PRIVATE = NO
\r
147 +EXTRACT_PACKAGE = NO
\r
148 +EXTRACT_STATIC = NO
\r
149 +EXTRACT_LOCAL_CLASSES = YES
\r
150 +EXTRACT_LOCAL_METHODS = NO
\r
151 +EXTRACT_ANON_NSPACES = NO
\r
152 +HIDE_UNDOC_MEMBERS = NO
\r
153 +HIDE_UNDOC_CLASSES = NO
\r
154 +HIDE_FRIEND_COMPOUNDS = NO
\r
155 +HIDE_IN_BODY_DOCS = NO
\r
156 +INTERNAL_DOCS = NO
\r
157 +CASE_SENSE_NAMES = YES
\r
158 +HIDE_SCOPE_NAMES = NO
\r
159 +SHOW_INCLUDE_FILES = NO
\r
160 +FORCE_LOCAL_INCLUDES = NO
\r
162 +SORT_MEMBER_DOCS = NO
\r
163 +SORT_BRIEF_DOCS = NO
\r
164 +SORT_MEMBERS_CTORS_1ST = NO
\r
165 +SORT_GROUP_NAMES = NO
\r
166 +SORT_BY_SCOPE_NAME = NO
\r
167 +STRICT_PROTO_MATCHING = NO
\r
168 +GENERATE_TODOLIST = NO
\r
169 +GENERATE_TESTLIST = NO
\r
170 +GENERATE_BUGLIST = NO
\r
171 +GENERATE_DEPRECATEDLIST= NO
\r
172 +ENABLED_SECTIONS =
\r
173 +MAX_INITIALIZER_LINES = 30
\r
174 +SHOW_USED_FILES = NO
\r
176 +SHOW_NAMESPACES = NO
\r
177 +FILE_VERSION_FILTER =
\r
180 +#---------------------------------------------------------------------------
\r
181 +# configuration options related to warning and progress messages
\r
182 +#---------------------------------------------------------------------------
\r
185 +WARN_IF_UNDOCUMENTED = YES
\r
186 +WARN_IF_DOC_ERROR = YES
\r
187 +WARN_NO_PARAMDOC = NO
\r
188 +WARN_FORMAT = "$file:$line: $text"
\r
190 +#---------------------------------------------------------------------------
\r
191 +# configuration options related to the input files
\r
192 +#---------------------------------------------------------------------------
\r
193 +INPUT = lib/notmuch.h
\r
194 +INPUT_ENCODING = UTF-8
\r
198 +EXCLUDE_SYMLINKS = NO
\r
199 +EXCLUDE_PATTERNS =
\r
202 +EXAMPLE_PATTERNS =
\r
203 +EXAMPLE_RECURSIVE = NO
\r
207 +FILTER_SOURCE_FILES = NO
\r
208 +FILTER_SOURCE_PATTERNS =
\r
209 +USE_MDFILE_AS_MAINPAGE =
\r
210 +#---------------------------------------------------------------------------
\r
211 +# configuration options related to source browsing
\r
212 +#---------------------------------------------------------------------------
\r
213 +SOURCE_BROWSER = NO
\r
214 +INLINE_SOURCES = NO
\r
215 +STRIP_CODE_COMMENTS = YES
\r
216 +REFERENCED_BY_RELATION = NO
\r
217 +REFERENCES_RELATION = NO
\r
218 +REFERENCES_LINK_SOURCE = YES
\r
220 +VERBATIM_HEADERS = NO
\r
221 +#---------------------------------------------------------------------------
\r
222 +# configuration options related to the alphabetical class index
\r
223 +#---------------------------------------------------------------------------
\r
224 +ALPHABETICAL_INDEX = NO
\r
225 +COLS_IN_ALPHA_INDEX = 5
\r
227 +#---------------------------------------------------------------------------
\r
228 +# configuration options related to the HTML output
\r
229 +#---------------------------------------------------------------------------
\r
230 +GENERATE_HTML = NO
\r
231 +HTML_OUTPUT = html
\r
232 +HTML_FILE_EXTENSION = .html
\r
236 +HTML_EXTRA_STYLESHEET =
\r
237 +HTML_EXTRA_FILES =
\r
238 +HTML_COLORSTYLE_HUE = 220
\r
239 +HTML_COLORSTYLE_SAT = 100
\r
240 +HTML_COLORSTYLE_GAMMA = 80
\r
241 +HTML_TIMESTAMP = YES
\r
242 +HTML_DYNAMIC_SECTIONS = NO
\r
243 +HTML_INDEX_NUM_ENTRIES = 100
\r
244 +GENERATE_DOCSET = NO
\r
245 +DOCSET_FEEDNAME = "Doxygen generated docs"
\r
246 +DOCSET_BUNDLE_ID = org.doxygen.Project
\r
247 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
\r
248 +DOCSET_PUBLISHER_NAME = Publisher
\r
249 +GENERATE_HTMLHELP = NO
\r
253 +CHM_INDEX_ENCODING =
\r
258 +QHP_NAMESPACE = org.doxygen.Project
\r
259 +QHP_VIRTUAL_FOLDER = doc
\r
260 +QHP_CUST_FILTER_NAME =
\r
261 +QHP_CUST_FILTER_ATTRS =
\r
262 +QHP_SECT_FILTER_ATTRS =
\r
264 +GENERATE_ECLIPSEHELP = NO
\r
265 +ECLIPSE_DOC_ID = org.doxygen.Project
\r
266 +DISABLE_INDEX = NO
\r
267 +GENERATE_TREEVIEW = NO
\r
268 +ENUM_VALUES_PER_LINE = 4
\r
269 +TREEVIEW_WIDTH = 250
\r
270 +EXT_LINKS_IN_WINDOW = NO
\r
271 +FORMULA_FONTSIZE = 10
\r
272 +FORMULA_TRANSPARENT = YES
\r
274 +MATHJAX_FORMAT = HTML-CSS
\r
275 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
\r
276 +MATHJAX_EXTENSIONS =
\r
277 +MATHJAX_CODEFILE =
\r
278 +SEARCHENGINE = YES
\r
279 +SERVER_BASED_SEARCH = NO
\r
280 +EXTERNAL_SEARCH = NO
\r
281 +SEARCHENGINE_URL =
\r
282 +SEARCHDATA_FILE = searchdata.xml
\r
283 +EXTERNAL_SEARCH_ID =
\r
284 +EXTRA_SEARCH_MAPPINGS =
\r
285 +#---------------------------------------------------------------------------
\r
286 +# configuration options related to the LaTeX output
\r
287 +#---------------------------------------------------------------------------
\r
288 +GENERATE_LATEX = NO
\r
289 +LATEX_OUTPUT = latex
\r
290 +LATEX_CMD_NAME = latex
\r
291 +MAKEINDEX_CMD_NAME = makeindex
\r
292 +COMPACT_LATEX = NO
\r
297 +LATEX_EXTRA_FILES =
\r
298 +PDF_HYPERLINKS = YES
\r
299 +USE_PDFLATEX = YES
\r
300 +LATEX_BATCHMODE = NO
\r
301 +LATEX_HIDE_INDICES = NO
\r
302 +LATEX_SOURCE_CODE = NO
\r
303 +LATEX_BIB_STYLE = plain
\r
304 +#---------------------------------------------------------------------------
\r
305 +# configuration options related to the RTF output
\r
306 +#---------------------------------------------------------------------------
\r
310 +RTF_HYPERLINKS = NO
\r
311 +RTF_STYLESHEET_FILE =
\r
312 +RTF_EXTENSIONS_FILE =
\r
313 +#---------------------------------------------------------------------------
\r
314 +# configuration options related to the man page output
\r
315 +#---------------------------------------------------------------------------
\r
316 +GENERATE_MAN = YES
\r
318 +MAN_EXTENSION = .3
\r
320 +#---------------------------------------------------------------------------
\r
321 +# configuration options related to the XML output
\r
322 +#---------------------------------------------------------------------------
\r
327 +XML_PROGRAMLISTING = YES
\r
328 +#---------------------------------------------------------------------------
\r
329 +# configuration options related to the DOCBOOK output
\r
330 +#---------------------------------------------------------------------------
\r
331 +GENERATE_DOCBOOK = NO
\r
332 +DOCBOOK_OUTPUT = docbook
\r
333 +#---------------------------------------------------------------------------
\r
334 +# configuration options for the AutoGen Definitions output
\r
335 +#---------------------------------------------------------------------------
\r
336 +GENERATE_AUTOGEN_DEF = NO
\r
337 +#---------------------------------------------------------------------------
\r
338 +# configuration options related to the Perl module output
\r
339 +#---------------------------------------------------------------------------
\r
340 +GENERATE_PERLMOD = NO
\r
341 +PERLMOD_LATEX = NO
\r
342 +PERLMOD_PRETTY = YES
\r
343 +PERLMOD_MAKEVAR_PREFIX =
\r
344 +#---------------------------------------------------------------------------
\r
345 +# Configuration options related to the preprocessor
\r
346 +#---------------------------------------------------------------------------
\r
347 +ENABLE_PREPROCESSING = YES
\r
348 +MACRO_EXPANSION = NO
\r
349 +EXPAND_ONLY_PREDEF = NO
\r
350 +SEARCH_INCLUDES = NO
\r
352 +INCLUDE_FILE_PATTERNS =
\r
353 +PREDEFINED = __DOXYGEN__
\r
354 +EXPAND_AS_DEFINED =
\r
355 +SKIP_FUNCTION_MACROS = YES
\r
356 +#---------------------------------------------------------------------------
\r
357 +# Configuration::additions related to external references
\r
358 +#---------------------------------------------------------------------------
\r
360 +GENERATE_TAGFILE =
\r
362 +EXTERNAL_GROUPS = NO
\r
363 +EXTERNAL_PAGES = NO
\r
364 +PERL_PATH = /usr/bin/perl
\r
365 +#---------------------------------------------------------------------------
\r
366 +# Configuration options related to the dot tool
\r
367 +#---------------------------------------------------------------------------
\r
368 +CLASS_DIAGRAMS = NO
\r
370 +HIDE_UNDOC_RELATIONS = YES
\r
372 +DOT_NUM_THREADS = 0
\r
373 +DOT_FONTNAME = Helvetica
\r
377 +COLLABORATION_GRAPH = YES
\r
378 +GROUP_GRAPHS = YES
\r
380 +UML_LIMIT_NUM_FIELDS = 10
\r
381 +TEMPLATE_RELATIONS = NO
\r
382 +INCLUDE_GRAPH = NO
\r
383 +INCLUDED_BY_GRAPH = NO
\r
386 +GRAPHICAL_HIERARCHY = NO
\r
387 +DIRECTORY_GRAPH = NO
\r
388 +DOT_IMAGE_FORMAT = png
\r
389 +INTERACTIVE_SVG = NO
\r
393 +DOT_GRAPH_MAX_NODES = 50
\r
394 +MAX_DOT_GRAPH_DEPTH = 0
\r
395 +DOT_TRANSPARENT = NO
\r
396 +DOT_MULTI_TARGETS = YES
\r
397 +GENERATE_LEGEND = NO
\r