Doxyfile-prj.cfg

#-----------------------------------------------------------------------------------
# d-SEAMS - Deferred Structural Elucidation Analysis for Molecular Simulations
#
# Copyright (c) 2018--present d-SEAMS core team
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the MIT License as published by
# the Open Source Initiative.
#
# A copy of the MIT License is included in the LICENSE file of this repository.
# You should have received a copy of the MIT License along with this program.
# If not, see <https://opensource.org/licenses/MIT>.
#-----------------------------------------------------------------------------------

# Customized Options
# Make changes here to prevent things from being overwritten when the main file
# is updated
# Defaults
@INCLUDE                = "./Doxyfile.cfg"

# XML
GENERATE_XML            = NO
XML_PROGRAMLISTING      = NO

# HTML
GENERATE_HTML           = YES
USE_MATHJAX             = YES

# LaTeX
GENERATE_LATEX          = NO

# Project Settings
PROJECT_NAME            = "d-SEAMS"
PROJECT_NUMBER          = "v1.0.0"
PROJECT_BRIEF           = "Deferred Structural Elucidation Analysis for Molecular Simulations"
PROJECT_LOGO            = "images/dSeamsLogo.png"
IMAGE_PATH             = "./images"

# Doxygen Settings
RECURSIVE              = YES
EXTRACT_ALL            = YES
INPUT                  = robots.txt README.md ./src/ ./markdown/
EXCLUDE                = ./src/include/external
USE_MDFILE_AS_MAINPAGE = README.md
CITE_BIB_FILES         = refs.bib

# Language additions
OPTIMIZE_OUTPUT_FOR_C = YES
BUILTIN_STL_SUPPORT = YES

# Style
JAVADOC_BANNER         = YES
JAVADOC_AUTOBRIEF      = NO
INHERIT_DOCS           = YES
INLINE_SOURCES         = YES
SOURCE_BROWSER         = YES
DISABLE_INDEX          = NO
GENERATE_TREEVIEW      = NO
HAVE_DOT               = YES
DOT_IMAGE_FORMAT       = YES
HTML_DYNAMIC_SECTIONS  = YES
INTERACTIVE_SVG        = YES
# Theme
HTML_HEADER            = "doxyYoda/html/header.html"
HTML_FOOTER            = "doxyYoda/html/footer.html"
HTML_EXTRA_STYLESHEET  = "doxyYoda/css/doxyYoda.min.css"
LAYOUT_FILE            = "doxyYoda/xml/doxyYoda.xml"

# We link to standard definitions
TAGFILES += "./tags/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"

# Extract everything
# EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = YES
EXTRACT_PRIV_VIRTUAL   = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
MACRO_EXPANSION        = YES
ENABLE_PREPROCESSING   = YES

# Lua Support
# EXTENSION_MAPPING =*.lua
# FILTER_PATTERNS=*.lua=lua2dox/lua2dox_filter
# FILE_PATTERNS          = *.lua

# Local Variables:
# mode: conf
# End: