[PATCH v2 1/2] devel: add doxygen configuration file
authorJani Nikula <jani@nikula.org>
Wed, 1 Jan 2014 17:52:53 +0000 (19:52 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:58:50 +0000 (09:58 -0800)
f6/377e12edd5289df3a52ad35a7fec55a0e3c148 [new file with mode: 0644]

diff --git a/f6/377e12edd5289df3a52ad35a7fec55a0e3c148 b/f6/377e12edd5289df3a52ad35a7fec55a0e3c148
new file mode 100644 (file)
index 0000000..d1a0046
--- /dev/null
@@ -0,0 +1,395 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id B5D23431FAF\r
+       for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 09:53:06 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.091\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.091 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7, UPPERCASE_50_75=0.791]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id thxkUtxhc3qb for <notmuch@notmuchmail.org>;\r
+       Wed,  1 Jan 2014 09:53:01 -0800 (PST)\r
+Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com\r
+ [74.125.83.41])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 6F515431FC0   for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 09:53:01 -0800\r
+ (PST)\r
+Received: by mail-ee0-f41.google.com with SMTP id t10so5986929eei.14\r
+       for <notmuch@notmuchmail.org>; Wed, 01 Jan 2014 09:53:00 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
+       :references:in-reply-to:references;\r
+       bh=uTrEEWh9XeNMAolYs9+odOqJWi9HQCa7qvCxWzl69BQ=;\r
+       b=MJGRfRWuut8htA7w5/vNsivJKIff3t3s1WXDnXC6IUYVU0z4onuu6oQmbgZ/CiUnJJ\r
+       IrFtT7U5qh2N93FRHVMqzUAV9bJDMpbNzYxgTnX9uQoVYIPetFYNUiNxnOIlf+oOTM/h\r
+       VNiuM+0oTbAr3Lw+mdrhdaf5n+DF0N+hU8Y53bEgESqlqPqEmLAK2xYm3azc+cVViyYC\r
+       ATbN6m9Q4Y19pboC7gBBUNsT68iboYn8fLvo+7s6WynZ1X1c1QNX4kl+IzBYt1G18k12\r
+       qlcCFQqu3RESVt+XvRZQh5hjOZ+G09Z3SXXqMDcQaTaDTb+jEYYiTa9IIsXUBfzUttRB\r
+       GZJQ==\r
+X-Gm-Message-State:\r
+ ALoCoQmV/F50M0ZkwkUUmm9UHnETSSza6L7SWgwi6WqI5AK6kDNm8se+ArCfXyFNyzdLQgmoPWc1\r
+X-Received: by 10.14.99.129 with SMTP id x1mr12010514eef.89.1388598780038;\r
+       Wed, 01 Jan 2014 09:53:00 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91]) by mx.google.com with ESMTPSA id\r
+       g47sm128879006eeo.19.2014.01.01.09.52.58 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Wed, 01 Jan 2014 09:52:59 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 1/2] devel: add doxygen configuration file\r
+Date: Wed,  1 Jan 2014 19:52:53 +0200\r
+Message-Id:\r
+ <f23ce4902a0d7a6351874457ae2344074ac405ad.1388598677.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.5.2\r
+In-Reply-To: <cover.1388598677.git.jani@nikula.org>\r
+References: <cover.1388598677.git.jani@nikula.org>\r
+In-Reply-To: <cover.1388598677.git.jani@nikula.org>\r
+References: <cover.1388598677.git.jani@nikula.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 01 Jan 2014 17:53:06 -0000\r
+\r
+This is a pretty basic config to get started, generated using 'doxygen\r
+-s -g' and mildly tweaked.\r
+\r
+To generate the library man page man/man3/notmuch.3 from lib/notmuch.h\r
+use:\r
+\r
+$ doxygen devel/doxygen.cfg\r
+---\r
+ devel/doxygen.cfg | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+ 1 file changed, 304 insertions(+)\r
+ create mode 100644 devel/doxygen.cfg\r
+\r
+diff --git a/devel/doxygen.cfg b/devel/doxygen.cfg\r
+new file mode 100644\r
+index 0000000..65d5fb5\r
+--- /dev/null\r
++++ b/devel/doxygen.cfg\r
+@@ -0,0 +1,304 @@\r
++# Doxyfile 1.8.4\r
++\r
++#---------------------------------------------------------------------------\r
++# Project related configuration options\r
++#---------------------------------------------------------------------------\r
++DOXYFILE_ENCODING      = UTF-8\r
++PROJECT_NAME           = "Notmuch 0.17"\r
++PROJECT_NUMBER         =\r
++PROJECT_BRIEF          =\r
++PROJECT_LOGO           =\r
++OUTPUT_DIRECTORY       =\r
++CREATE_SUBDIRS         = NO\r
++OUTPUT_LANGUAGE        = English\r
++BRIEF_MEMBER_DESC      = YES\r
++REPEAT_BRIEF           = YES\r
++ABBREVIATE_BRIEF       =\r
++ALWAYS_DETAILED_SEC    = NO\r
++INLINE_INHERITED_MEMB  = NO\r
++FULL_PATH_NAMES        = NO\r
++STRIP_FROM_PATH        =\r
++STRIP_FROM_INC_PATH    =\r
++SHORT_NAMES            = NO\r
++JAVADOC_AUTOBRIEF      = YES\r
++QT_AUTOBRIEF           = NO\r
++MULTILINE_CPP_IS_BRIEF = NO\r
++INHERIT_DOCS           = YES\r
++SEPARATE_MEMBER_PAGES  = NO\r
++TAB_SIZE               = 8\r
++ALIASES                =\r
++TCL_SUBST              =\r
++OPTIMIZE_OUTPUT_FOR_C  = YES\r
++OPTIMIZE_OUTPUT_JAVA   = NO\r
++OPTIMIZE_FOR_FORTRAN   = NO\r
++OPTIMIZE_OUTPUT_VHDL   = NO\r
++EXTENSION_MAPPING      =\r
++MARKDOWN_SUPPORT       = YES\r
++AUTOLINK_SUPPORT       = YES\r
++BUILTIN_STL_SUPPORT    = NO\r
++CPP_CLI_SUPPORT        = NO\r
++SIP_SUPPORT            = NO\r
++IDL_PROPERTY_SUPPORT   = YES\r
++DISTRIBUTE_GROUP_DOC   = NO\r
++SUBGROUPING            = YES\r
++INLINE_GROUPED_CLASSES = NO\r
++INLINE_SIMPLE_STRUCTS  = NO\r
++TYPEDEF_HIDES_STRUCT   = YES\r
++LOOKUP_CACHE_SIZE      = 0\r
++#---------------------------------------------------------------------------\r
++# Build related configuration options\r
++#---------------------------------------------------------------------------\r
++EXTRACT_ALL            = NO\r
++EXTRACT_PRIVATE        = NO\r
++EXTRACT_PACKAGE        = NO\r
++EXTRACT_STATIC         = NO\r
++EXTRACT_LOCAL_CLASSES  = YES\r
++EXTRACT_LOCAL_METHODS  = NO\r
++EXTRACT_ANON_NSPACES   = NO\r
++HIDE_UNDOC_MEMBERS     = NO\r
++HIDE_UNDOC_CLASSES     = NO\r
++HIDE_FRIEND_COMPOUNDS  = NO\r
++HIDE_IN_BODY_DOCS      = NO\r
++INTERNAL_DOCS          = NO\r
++CASE_SENSE_NAMES       = YES\r
++HIDE_SCOPE_NAMES       = NO\r
++SHOW_INCLUDE_FILES     = NO\r
++FORCE_LOCAL_INCLUDES   = NO\r
++INLINE_INFO            = YES\r
++SORT_MEMBER_DOCS       = NO\r
++SORT_BRIEF_DOCS        = NO\r
++SORT_MEMBERS_CTORS_1ST = NO\r
++SORT_GROUP_NAMES       = NO\r
++SORT_BY_SCOPE_NAME     = NO\r
++STRICT_PROTO_MATCHING  = NO\r
++GENERATE_TODOLIST      = NO\r
++GENERATE_TESTLIST      = NO\r
++GENERATE_BUGLIST       = NO\r
++GENERATE_DEPRECATEDLIST= NO\r
++ENABLED_SECTIONS       =\r
++MAX_INITIALIZER_LINES  = 30\r
++SHOW_USED_FILES        = NO\r
++SHOW_FILES             = NO\r
++SHOW_NAMESPACES        = NO\r
++FILE_VERSION_FILTER    =\r
++LAYOUT_FILE            =\r
++CITE_BIB_FILES         =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to warning and progress messages\r
++#---------------------------------------------------------------------------\r
++QUIET                  = YES\r
++WARNINGS               = YES\r
++WARN_IF_UNDOCUMENTED   = YES\r
++WARN_IF_DOC_ERROR      = YES\r
++WARN_NO_PARAMDOC       = NO\r
++WARN_FORMAT            = "$file:$line: $text"\r
++WARN_LOGFILE           =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the input files\r
++#---------------------------------------------------------------------------\r
++INPUT                  = lib/notmuch.h\r
++INPUT_ENCODING         = UTF-8\r
++FILE_PATTERNS          =\r
++RECURSIVE              = NO\r
++EXCLUDE                =\r
++EXCLUDE_SYMLINKS       = NO\r
++EXCLUDE_PATTERNS       =\r
++EXCLUDE_SYMBOLS        =\r
++EXAMPLE_PATH           =\r
++EXAMPLE_PATTERNS       =\r
++EXAMPLE_RECURSIVE      = NO\r
++IMAGE_PATH             =\r
++INPUT_FILTER           =\r
++FILTER_PATTERNS        =\r
++FILTER_SOURCE_FILES    = NO\r
++FILTER_SOURCE_PATTERNS =\r
++USE_MDFILE_AS_MAINPAGE =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to source browsing\r
++#---------------------------------------------------------------------------\r
++SOURCE_BROWSER         = NO\r
++INLINE_SOURCES         = NO\r
++STRIP_CODE_COMMENTS    = YES\r
++REFERENCED_BY_RELATION = NO\r
++REFERENCES_RELATION    = NO\r
++REFERENCES_LINK_SOURCE = YES\r
++USE_HTAGS              = NO\r
++VERBATIM_HEADERS       = NO\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the alphabetical class index\r
++#---------------------------------------------------------------------------\r
++ALPHABETICAL_INDEX     = NO\r
++COLS_IN_ALPHA_INDEX    = 5\r
++IGNORE_PREFIX          =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the HTML output\r
++#---------------------------------------------------------------------------\r
++GENERATE_HTML          = NO\r
++HTML_OUTPUT            = html\r
++HTML_FILE_EXTENSION    = .html\r
++HTML_HEADER            =\r
++HTML_FOOTER            =\r
++HTML_STYLESHEET        =\r
++HTML_EXTRA_STYLESHEET  =\r
++HTML_EXTRA_FILES       =\r
++HTML_COLORSTYLE_HUE    = 220\r
++HTML_COLORSTYLE_SAT    = 100\r
++HTML_COLORSTYLE_GAMMA  = 80\r
++HTML_TIMESTAMP         = YES\r
++HTML_DYNAMIC_SECTIONS  = NO\r
++HTML_INDEX_NUM_ENTRIES = 100\r
++GENERATE_DOCSET        = NO\r
++DOCSET_FEEDNAME        = "Doxygen generated docs"\r
++DOCSET_BUNDLE_ID       = org.doxygen.Project\r
++DOCSET_PUBLISHER_ID    = org.doxygen.Publisher\r
++DOCSET_PUBLISHER_NAME  = Publisher\r
++GENERATE_HTMLHELP      = NO\r
++CHM_FILE               =\r
++HHC_LOCATION           =\r
++GENERATE_CHI           = NO\r
++CHM_INDEX_ENCODING     =\r
++BINARY_TOC             = NO\r
++TOC_EXPAND             = NO\r
++GENERATE_QHP           = NO\r
++QCH_FILE               =\r
++QHP_NAMESPACE          = org.doxygen.Project\r
++QHP_VIRTUAL_FOLDER     = doc\r
++QHP_CUST_FILTER_NAME   =\r
++QHP_CUST_FILTER_ATTRS  =\r
++QHP_SECT_FILTER_ATTRS  =\r
++QHG_LOCATION           =\r
++GENERATE_ECLIPSEHELP   = NO\r
++ECLIPSE_DOC_ID         = org.doxygen.Project\r
++DISABLE_INDEX          = NO\r
++GENERATE_TREEVIEW      = NO\r
++ENUM_VALUES_PER_LINE   = 4\r
++TREEVIEW_WIDTH         = 250\r
++EXT_LINKS_IN_WINDOW    = NO\r
++FORMULA_FONTSIZE       = 10\r
++FORMULA_TRANSPARENT    = YES\r
++USE_MATHJAX            = NO\r
++MATHJAX_FORMAT         = HTML-CSS\r
++MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest\r
++MATHJAX_EXTENSIONS     =\r
++MATHJAX_CODEFILE       =\r
++SEARCHENGINE           = YES\r
++SERVER_BASED_SEARCH    = NO\r
++EXTERNAL_SEARCH        = NO\r
++SEARCHENGINE_URL       =\r
++SEARCHDATA_FILE        = searchdata.xml\r
++EXTERNAL_SEARCH_ID     =\r
++EXTRA_SEARCH_MAPPINGS  =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the LaTeX output\r
++#---------------------------------------------------------------------------\r
++GENERATE_LATEX         = NO\r
++LATEX_OUTPUT           = latex\r
++LATEX_CMD_NAME         = latex\r
++MAKEINDEX_CMD_NAME     = makeindex\r
++COMPACT_LATEX          = NO\r
++PAPER_TYPE             = a4\r
++EXTRA_PACKAGES         =\r
++LATEX_HEADER           =\r
++LATEX_FOOTER           =\r
++LATEX_EXTRA_FILES      =\r
++PDF_HYPERLINKS         = YES\r
++USE_PDFLATEX           = YES\r
++LATEX_BATCHMODE        = NO\r
++LATEX_HIDE_INDICES     = NO\r
++LATEX_SOURCE_CODE      = NO\r
++LATEX_BIB_STYLE        = plain\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the RTF output\r
++#---------------------------------------------------------------------------\r
++GENERATE_RTF           = NO\r
++RTF_OUTPUT             = rtf\r
++COMPACT_RTF            = NO\r
++RTF_HYPERLINKS         = NO\r
++RTF_STYLESHEET_FILE    =\r
++RTF_EXTENSIONS_FILE    =\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the man page output\r
++#---------------------------------------------------------------------------\r
++GENERATE_MAN           = YES\r
++MAN_OUTPUT             = man\r
++MAN_EXTENSION          = .3\r
++MAN_LINKS              = NO\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the XML output\r
++#---------------------------------------------------------------------------\r
++GENERATE_XML           = NO\r
++XML_OUTPUT             = xml\r
++XML_SCHEMA             =\r
++XML_DTD                =\r
++XML_PROGRAMLISTING     = YES\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the DOCBOOK output\r
++#---------------------------------------------------------------------------\r
++GENERATE_DOCBOOK       = NO\r
++DOCBOOK_OUTPUT         = docbook\r
++#---------------------------------------------------------------------------\r
++# configuration options for the AutoGen Definitions output\r
++#---------------------------------------------------------------------------\r
++GENERATE_AUTOGEN_DEF   = NO\r
++#---------------------------------------------------------------------------\r
++# configuration options related to the Perl module output\r
++#---------------------------------------------------------------------------\r
++GENERATE_PERLMOD       = NO\r
++PERLMOD_LATEX          = NO\r
++PERLMOD_PRETTY         = YES\r
++PERLMOD_MAKEVAR_PREFIX =\r
++#---------------------------------------------------------------------------\r
++# Configuration options related to the preprocessor\r
++#---------------------------------------------------------------------------\r
++ENABLE_PREPROCESSING   = YES\r
++MACRO_EXPANSION        = NO\r
++EXPAND_ONLY_PREDEF     = NO\r
++SEARCH_INCLUDES        = NO\r
++INCLUDE_PATH           =\r
++INCLUDE_FILE_PATTERNS  =\r
++PREDEFINED             = __DOXYGEN__\r
++EXPAND_AS_DEFINED      =\r
++SKIP_FUNCTION_MACROS   = YES\r
++#---------------------------------------------------------------------------\r
++# Configuration::additions related to external references\r
++#---------------------------------------------------------------------------\r
++TAGFILES               =\r
++GENERATE_TAGFILE       =\r
++ALLEXTERNALS           = NO\r
++EXTERNAL_GROUPS        = NO\r
++EXTERNAL_PAGES         = NO\r
++PERL_PATH              = /usr/bin/perl\r
++#---------------------------------------------------------------------------\r
++# Configuration options related to the dot tool\r
++#---------------------------------------------------------------------------\r
++CLASS_DIAGRAMS         = NO\r
++MSCGEN_PATH            =\r
++HIDE_UNDOC_RELATIONS   = YES\r
++HAVE_DOT               = NO\r
++DOT_NUM_THREADS        = 0\r
++DOT_FONTNAME           = Helvetica\r
++DOT_FONTSIZE           = 10\r
++DOT_FONTPATH           =\r
++CLASS_GRAPH            = YES\r
++COLLABORATION_GRAPH    = YES\r
++GROUP_GRAPHS           = YES\r
++UML_LOOK               = NO\r
++UML_LIMIT_NUM_FIELDS   = 10\r
++TEMPLATE_RELATIONS     = NO\r
++INCLUDE_GRAPH          = NO\r
++INCLUDED_BY_GRAPH      = NO\r
++CALL_GRAPH             = NO\r
++CALLER_GRAPH           = NO\r
++GRAPHICAL_HIERARCHY    = NO\r
++DIRECTORY_GRAPH        = NO\r
++DOT_IMAGE_FORMAT       = png\r
++INTERACTIVE_SVG        = NO\r
++DOT_PATH               =\r
++DOTFILE_DIRS           =\r
++MSCFILE_DIRS           =\r
++DOT_GRAPH_MAX_NODES    = 50\r
++MAX_DOT_GRAPH_DEPTH    = 0\r
++DOT_TRANSPARENT        = NO\r
++DOT_MULTI_TARGETS      = YES\r
++GENERATE_LEGEND        = NO\r
++DOT_CLEANUP            = YES\r
+-- \r
+1.8.5.2\r
+\r