From: Jani Nikula Date: Sun, 1 Dec 2013 09:39:23 +0000 (+0200) Subject: [PATCH] devel: add doxygen configuration file X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d9de835ba789cdef1224846c981037d76995f050;p=notmuch-archives.git [PATCH] devel: add doxygen configuration file --- diff --git a/e1/9ba700f0a54803e15c07819507683f085f8585 b/e1/9ba700f0a54803e15c07819507683f085f8585 new file mode 100644 index 000000000..5fcdbcf63 --- /dev/null +++ b/e1/9ba700f0a54803e15c07819507683f085f8585 @@ -0,0 +1,401 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id A0101431FDC + for ; Sun, 1 Dec 2013 02:03:48 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.091 +X-Spam-Level: +X-Spam-Status: No, score=0.091 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7, UPPERCASE_50_75=0.791] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id U3IVs8u7a32B for ; + Sun, 1 Dec 2013 02:03:38 -0800 (PST) +Received: from mail-ea0-f182.google.com (mail-ea0-f182.google.com + [209.85.215.182]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6FB92431FD0 + for ; Sun, 1 Dec 2013 02:03:38 -0800 (PST) +Received: by mail-ea0-f182.google.com with SMTP id o10so11195158eaj.27 + for ; Sun, 01 Dec 2013 02:03:37 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20130820; + h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to + :references; + bh=DrDwJmqltKj6RVws8MiBiswPTh4a9F/wEhpnxX0EMPY=; + b=jCHwFFD2URcLc6OaNciwUWitDncwVYtt+m3aNiH13E54WPW09o9FakUC2MWGf/hM5e + BdL23gYHYndmJworU4RJSHRkK96+SU9/PJWp4o0bcZZ1ir6gA9lNkwXYmcl7tQymkutG + YASPh/OX36+67jBwFKe6p+2PHshnP2eOFvmQRKEF83DysJ2hj6B3/27KC4CCjQT3zVlu + SMN3BqV7qeZ3v7HDzg9LxSGalwcp/9T7+u35SFOYCTjB9aVVAa18Ziuwt4aBvJd7RTHs + 2xYkVGEErwgLzKy20EALZLnRJapNsxnWzqExPtyaFSQSMvad800lotANr8Yy6XvJ4AK9 + Isfw== +X-Gm-Message-State: + ALoCoQntcGpFl/9/Ay/fRtOo2q0sKWuwugBKdCNtsz07qyyCEMZIsWM29OQ2cr9UqeTpkPznjE5l +X-Received: by 10.15.50.195 with SMTP id l43mr60501400eew.30.1385890767997; + Sun, 01 Dec 2013 01:39:27 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) + by mx.google.com with ESMTPSA id l4sm23394788een.13.2013.12.01.01.39.26 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sun, 01 Dec 2013 01:39:26 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH] devel: add doxygen configuration file +Date: Sun, 1 Dec 2013 11:39:23 +0200 +Message-Id: <1385890763-15161-1-git-send-email-jani@nikula.org> +X-Mailer: git-send-email 1.8.4.2 +In-Reply-To: + <4000d64d9fa9e0954ace15dcdf97f1a39b6b6145.1385826040.git.jani@nikula.org> +References: + <4000d64d9fa9e0954ace15dcdf97f1a39b6b6145.1385826040.git.jani@nikula.org> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 01 Dec 2013 10:03:48 -0000 + +To generate library man page from lib/notmuch.h using + +$ doxygen devel/doxygen.cfg + +--- + +Same as before but with comments removed using: +$ doxygen -s -u devel/doxygen.cfg + +You can get the comments back with: +$ doxygen -u devel/doxygen.cfg + +Removing the explicitly set defaults or unused config options requires +more effort. +--- + devel/doxygen.cfg | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + 1 file changed, 304 insertions(+) + create mode 100644 devel/doxygen.cfg + +diff --git a/devel/doxygen.cfg b/devel/doxygen.cfg +new file mode 100644 +index 0000000..65d5fb5 +--- /dev/null ++++ b/devel/doxygen.cfg +@@ -0,0 +1,304 @@ ++# Doxyfile 1.8.4 ++ ++#--------------------------------------------------------------------------- ++# Project related configuration options ++#--------------------------------------------------------------------------- ++DOXYFILE_ENCODING = UTF-8 ++PROJECT_NAME = "Notmuch 0.17" ++PROJECT_NUMBER = ++PROJECT_BRIEF = ++PROJECT_LOGO = ++OUTPUT_DIRECTORY = ++CREATE_SUBDIRS = NO ++OUTPUT_LANGUAGE = English ++BRIEF_MEMBER_DESC = YES ++REPEAT_BRIEF = YES ++ABBREVIATE_BRIEF = ++ALWAYS_DETAILED_SEC = NO ++INLINE_INHERITED_MEMB = NO ++FULL_PATH_NAMES = NO ++STRIP_FROM_PATH = ++STRIP_FROM_INC_PATH = ++SHORT_NAMES = NO ++JAVADOC_AUTOBRIEF = YES ++QT_AUTOBRIEF = NO ++MULTILINE_CPP_IS_BRIEF = NO ++INHERIT_DOCS = YES ++SEPARATE_MEMBER_PAGES = NO ++TAB_SIZE = 8 ++ALIASES = ++TCL_SUBST = ++OPTIMIZE_OUTPUT_FOR_C = YES ++OPTIMIZE_OUTPUT_JAVA = NO ++OPTIMIZE_FOR_FORTRAN = NO ++OPTIMIZE_OUTPUT_VHDL = NO ++EXTENSION_MAPPING = ++MARKDOWN_SUPPORT = YES ++AUTOLINK_SUPPORT = YES ++BUILTIN_STL_SUPPORT = NO ++CPP_CLI_SUPPORT = NO ++SIP_SUPPORT = NO ++IDL_PROPERTY_SUPPORT = YES ++DISTRIBUTE_GROUP_DOC = NO ++SUBGROUPING = YES ++INLINE_GROUPED_CLASSES = NO ++INLINE_SIMPLE_STRUCTS = NO ++TYPEDEF_HIDES_STRUCT = YES ++LOOKUP_CACHE_SIZE = 0 ++#--------------------------------------------------------------------------- ++# Build related configuration options ++#--------------------------------------------------------------------------- ++EXTRACT_ALL = NO ++EXTRACT_PRIVATE = NO ++EXTRACT_PACKAGE = NO ++EXTRACT_STATIC = NO ++EXTRACT_LOCAL_CLASSES = YES ++EXTRACT_LOCAL_METHODS = NO ++EXTRACT_ANON_NSPACES = NO ++HIDE_UNDOC_MEMBERS = NO ++HIDE_UNDOC_CLASSES = NO ++HIDE_FRIEND_COMPOUNDS = NO ++HIDE_IN_BODY_DOCS = NO ++INTERNAL_DOCS = NO ++CASE_SENSE_NAMES = YES ++HIDE_SCOPE_NAMES = NO ++SHOW_INCLUDE_FILES = NO ++FORCE_LOCAL_INCLUDES = NO ++INLINE_INFO = YES ++SORT_MEMBER_DOCS = NO ++SORT_BRIEF_DOCS = NO ++SORT_MEMBERS_CTORS_1ST = NO ++SORT_GROUP_NAMES = NO ++SORT_BY_SCOPE_NAME = NO ++STRICT_PROTO_MATCHING = NO ++GENERATE_TODOLIST = NO ++GENERATE_TESTLIST = NO ++GENERATE_BUGLIST = NO ++GENERATE_DEPRECATEDLIST= NO ++ENABLED_SECTIONS = ++MAX_INITIALIZER_LINES = 30 ++SHOW_USED_FILES = NO ++SHOW_FILES = NO ++SHOW_NAMESPACES = NO ++FILE_VERSION_FILTER = ++LAYOUT_FILE = ++CITE_BIB_FILES = ++#--------------------------------------------------------------------------- ++# configuration options related to warning and progress messages ++#--------------------------------------------------------------------------- ++QUIET = YES ++WARNINGS = YES ++WARN_IF_UNDOCUMENTED = YES ++WARN_IF_DOC_ERROR = YES ++WARN_NO_PARAMDOC = NO ++WARN_FORMAT = "$file:$line: $text" ++WARN_LOGFILE = ++#--------------------------------------------------------------------------- ++# configuration options related to the input files ++#--------------------------------------------------------------------------- ++INPUT = lib/notmuch.h ++INPUT_ENCODING = UTF-8 ++FILE_PATTERNS = ++RECURSIVE = NO ++EXCLUDE = ++EXCLUDE_SYMLINKS = NO ++EXCLUDE_PATTERNS = ++EXCLUDE_SYMBOLS = ++EXAMPLE_PATH = ++EXAMPLE_PATTERNS = ++EXAMPLE_RECURSIVE = NO ++IMAGE_PATH = ++INPUT_FILTER = ++FILTER_PATTERNS = ++FILTER_SOURCE_FILES = NO ++FILTER_SOURCE_PATTERNS = ++USE_MDFILE_AS_MAINPAGE = ++#--------------------------------------------------------------------------- ++# configuration options related to source browsing ++#--------------------------------------------------------------------------- ++SOURCE_BROWSER = NO ++INLINE_SOURCES = NO ++STRIP_CODE_COMMENTS = YES ++REFERENCED_BY_RELATION = NO ++REFERENCES_RELATION = NO ++REFERENCES_LINK_SOURCE = YES ++USE_HTAGS = NO ++VERBATIM_HEADERS = NO ++#--------------------------------------------------------------------------- ++# configuration options related to the alphabetical class index ++#--------------------------------------------------------------------------- ++ALPHABETICAL_INDEX = NO ++COLS_IN_ALPHA_INDEX = 5 ++IGNORE_PREFIX = ++#--------------------------------------------------------------------------- ++# configuration options related to the HTML output ++#--------------------------------------------------------------------------- ++GENERATE_HTML = NO ++HTML_OUTPUT = html ++HTML_FILE_EXTENSION = .html ++HTML_HEADER = ++HTML_FOOTER = ++HTML_STYLESHEET = ++HTML_EXTRA_STYLESHEET = ++HTML_EXTRA_FILES = ++HTML_COLORSTYLE_HUE = 220 ++HTML_COLORSTYLE_SAT = 100 ++HTML_COLORSTYLE_GAMMA = 80 ++HTML_TIMESTAMP = YES ++HTML_DYNAMIC_SECTIONS = NO ++HTML_INDEX_NUM_ENTRIES = 100 ++GENERATE_DOCSET = NO ++DOCSET_FEEDNAME = "Doxygen generated docs" ++DOCSET_BUNDLE_ID = org.doxygen.Project ++DOCSET_PUBLISHER_ID = org.doxygen.Publisher ++DOCSET_PUBLISHER_NAME = Publisher ++GENERATE_HTMLHELP = NO ++CHM_FILE = ++HHC_LOCATION = ++GENERATE_CHI = NO ++CHM_INDEX_ENCODING = ++BINARY_TOC = NO ++TOC_EXPAND = NO ++GENERATE_QHP = NO ++QCH_FILE = ++QHP_NAMESPACE = org.doxygen.Project ++QHP_VIRTUAL_FOLDER = doc ++QHP_CUST_FILTER_NAME = ++QHP_CUST_FILTER_ATTRS = ++QHP_SECT_FILTER_ATTRS = ++QHG_LOCATION = ++GENERATE_ECLIPSEHELP = NO ++ECLIPSE_DOC_ID = org.doxygen.Project ++DISABLE_INDEX = NO ++GENERATE_TREEVIEW = NO ++ENUM_VALUES_PER_LINE = 4 ++TREEVIEW_WIDTH = 250 ++EXT_LINKS_IN_WINDOW = NO ++FORMULA_FONTSIZE = 10 ++FORMULA_TRANSPARENT = YES ++USE_MATHJAX = NO ++MATHJAX_FORMAT = HTML-CSS ++MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest ++MATHJAX_EXTENSIONS = ++MATHJAX_CODEFILE = ++SEARCHENGINE = YES ++SERVER_BASED_SEARCH = NO ++EXTERNAL_SEARCH = NO ++SEARCHENGINE_URL = ++SEARCHDATA_FILE = searchdata.xml ++EXTERNAL_SEARCH_ID = ++EXTRA_SEARCH_MAPPINGS = ++#--------------------------------------------------------------------------- ++# configuration options related to the LaTeX output ++#--------------------------------------------------------------------------- ++GENERATE_LATEX = NO ++LATEX_OUTPUT = latex ++LATEX_CMD_NAME = latex ++MAKEINDEX_CMD_NAME = makeindex ++COMPACT_LATEX = NO ++PAPER_TYPE = a4 ++EXTRA_PACKAGES = ++LATEX_HEADER = ++LATEX_FOOTER = ++LATEX_EXTRA_FILES = ++PDF_HYPERLINKS = YES ++USE_PDFLATEX = YES ++LATEX_BATCHMODE = NO ++LATEX_HIDE_INDICES = NO ++LATEX_SOURCE_CODE = NO ++LATEX_BIB_STYLE = plain ++#--------------------------------------------------------------------------- ++# configuration options related to the RTF output ++#--------------------------------------------------------------------------- ++GENERATE_RTF = NO ++RTF_OUTPUT = rtf ++COMPACT_RTF = NO ++RTF_HYPERLINKS = NO ++RTF_STYLESHEET_FILE = ++RTF_EXTENSIONS_FILE = ++#--------------------------------------------------------------------------- ++# configuration options related to the man page output ++#--------------------------------------------------------------------------- ++GENERATE_MAN = YES ++MAN_OUTPUT = man ++MAN_EXTENSION = .3 ++MAN_LINKS = NO ++#--------------------------------------------------------------------------- ++# configuration options related to the XML output ++#--------------------------------------------------------------------------- ++GENERATE_XML = NO ++XML_OUTPUT = xml ++XML_SCHEMA = ++XML_DTD = ++XML_PROGRAMLISTING = YES ++#--------------------------------------------------------------------------- ++# configuration options related to the DOCBOOK output ++#--------------------------------------------------------------------------- ++GENERATE_DOCBOOK = NO ++DOCBOOK_OUTPUT = docbook ++#--------------------------------------------------------------------------- ++# configuration options for the AutoGen Definitions output ++#--------------------------------------------------------------------------- ++GENERATE_AUTOGEN_DEF = NO ++#--------------------------------------------------------------------------- ++# configuration options related to the Perl module output ++#--------------------------------------------------------------------------- ++GENERATE_PERLMOD = NO ++PERLMOD_LATEX = NO ++PERLMOD_PRETTY = YES ++PERLMOD_MAKEVAR_PREFIX = ++#--------------------------------------------------------------------------- ++# Configuration options related to the preprocessor ++#--------------------------------------------------------------------------- ++ENABLE_PREPROCESSING = YES ++MACRO_EXPANSION = NO ++EXPAND_ONLY_PREDEF = NO ++SEARCH_INCLUDES = NO ++INCLUDE_PATH = ++INCLUDE_FILE_PATTERNS = ++PREDEFINED = __DOXYGEN__ ++EXPAND_AS_DEFINED = ++SKIP_FUNCTION_MACROS = YES ++#--------------------------------------------------------------------------- ++# Configuration::additions related to external references ++#--------------------------------------------------------------------------- ++TAGFILES = ++GENERATE_TAGFILE = ++ALLEXTERNALS = NO ++EXTERNAL_GROUPS = NO ++EXTERNAL_PAGES = NO ++PERL_PATH = /usr/bin/perl ++#--------------------------------------------------------------------------- ++# Configuration options related to the dot tool ++#--------------------------------------------------------------------------- ++CLASS_DIAGRAMS = NO ++MSCGEN_PATH = ++HIDE_UNDOC_RELATIONS = YES ++HAVE_DOT = NO ++DOT_NUM_THREADS = 0 ++DOT_FONTNAME = Helvetica ++DOT_FONTSIZE = 10 ++DOT_FONTPATH = ++CLASS_GRAPH = YES ++COLLABORATION_GRAPH = YES ++GROUP_GRAPHS = YES ++UML_LOOK = NO ++UML_LIMIT_NUM_FIELDS = 10 ++TEMPLATE_RELATIONS = NO ++INCLUDE_GRAPH = NO ++INCLUDED_BY_GRAPH = NO ++CALL_GRAPH = NO ++CALLER_GRAPH = NO ++GRAPHICAL_HIERARCHY = NO ++DIRECTORY_GRAPH = NO ++DOT_IMAGE_FORMAT = png ++INTERACTIVE_SVG = NO ++DOT_PATH = ++DOTFILE_DIRS = ++MSCFILE_DIRS = ++DOT_GRAPH_MAX_NODES = 50 ++MAX_DOT_GRAPH_DEPTH = 0 ++DOT_TRANSPARENT = NO ++DOT_MULTI_TARGETS = YES ++GENERATE_LEGEND = NO ++DOT_CLEANUP = YES +-- +1.8.4.2 +