Doxyfile.in

# Copyright Louis Dionne 2013-2022
# Distributed under the Boost Software License, Version 1.0.
# (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)

PROJECT_NAME            = "Boost.Hana"
PROJECT_BRIEF           = "Your standard library for metaprogramming"
PROJECT_LOGO            = @Boost.Hana_SOURCE_DIR@/doc/icons/Boost.png
PROJECT_NUMBER          = @Boost.Hana_VERSION_STRING@

STRIP_FROM_PATH         = @Boost.Hana_SOURCE_DIR@/include
BUILTIN_STL_SUPPORT     = NO # Allows us to document std:: classes ourselves
STRIP_FROM_INC_PATH     = @Boost.Hana_SOURCE_DIR@/include
ALIASES                 =
ENABLED_SECTIONS        =
QUIET                   = YES

# Resources
OUTPUT_DIRECTORY        = @CMAKE_CURRENT_BINARY_DIR@
INPUT                   = @Boost.Hana_SOURCE_DIR@/include \
                          @Boost.Hana_SOURCE_DIR@/doc/tutorial.hpp
FILE_PATTERNS           = *.hpp
RECURSIVE               = YES
EXCLUDE                 =
EXCLUDE_PATTERNS        = *.erb*
EXAMPLE_PATH            = @Boost.Hana_SOURCE_DIR@/example \
                          @Boost.Hana_SOURCE_DIR@/test
EXAMPLE_RECURSIVE       = YES
WARN_IF_UNDOCUMENTED    = NO

SHOW_GROUPED_MEMB_INC   = YES
BRIEF_MEMBER_DESC       = YES
REPEAT_BRIEF            = YES
ALWAYS_DETAILED_SEC     = NO
INLINE_INHERITED_MEMB   = NO
JAVADOC_AUTOBRIEF       = YES
QT_AUTOBRIEF            = YES
MULTILINE_CPP_IS_BRIEF  = YES
INHERIT_DOCS            = NO
SEPARATE_MEMBER_PAGES   = NO
DISTRIBUTE_GROUP_DOC    = NO
SUBGROUPING             = NO
INLINE_GROUPED_CLASSES  = NO
INLINE_SIMPLE_STRUCTS   = NO

# Generated formats
GENERATE_HTML           = YES
GENERATE_LATEX          = NO
GENERATE_DOCSET         = @HANA_GENERATE_DOCSET@
DOCSET_BUNDLE_ID        = boost.hana


GENERATE_TODOLIST       = YES
GENERATE_TESTLIST       = YES
GENERATE_BUGLIST        = YES
GENERATE_DEPRECATEDLIST = YES
SHOW_USED_FILES         = NO
SHOW_FILES              = YES
SHOW_NAMESPACES         = YES
LAYOUT_FILE             = @Boost.Hana_SOURCE_DIR@/doc/layout.xml


CLASS_DIAGRAMS          = YES
HAVE_DOT                = NO

HIDE_UNDOC_RELATIONS    = NO
HIDE_UNDOC_MEMBERS      = YES
HIDE_UNDOC_CLASSES      = YES
HIDE_FRIEND_COMPOUNDS   = NO
HIDE_IN_BODY_DOCS       = NO
INTERNAL_DOCS           = YES
HIDE_SCOPE_NAMES        = NO
SHOW_INCLUDE_FILES      = NO
FORCE_LOCAL_INCLUDES    = NO
INLINE_INFO             = NO
SORT_MEMBER_DOCS        = NO
SORT_BRIEF_DOCS         = NO
SORT_MEMBERS_CTORS_1ST  = NO
SORT_GROUP_NAMES        = NO
SORT_BY_SCOPE_NAME      = YES


ALPHABETICAL_INDEX      = NO
COLS_IN_ALPHA_INDEX     = 1

# Preprocessing
ENABLE_PREPROCESSING    = YES
MACRO_EXPANSION         = YES
EXPAND_ONLY_PREDEF      = NO
SEARCH_INCLUDES         = YES
INCLUDE_PATH            = @Boost.Hana_SOURCE_DIR@/include
INCLUDE_FILE_PATTERNS   =
PREDEFINED              = BOOST_HANA_DOXYGEN_INVOKED
SKIP_FUNCTION_MACROS    = NO

# Source browsing
SOURCE_BROWSER          = NO
INLINE_SOURCES          = NO
STRIP_CODE_COMMENTS     = NO
REFERENCED_BY_RELATION  = YES
REFERENCES_RELATION     = YES
REFERENCES_LINK_SOURCE  = YES
USE_HTAGS               = NO
VERBATIM_HEADERS        = NO
# CLANG_ASSISTED_PARSING  = NO
# CLANG_OPTIONS           =

# HTML output
HTML_OUTPUT             = @HANA_HTML_OUTPUT@
HTML_FILE_EXTENSION     = .html
HTML_HEADER             = @Boost.Hana_SOURCE_DIR@/doc/header.html
HTML_FOOTER             = @Boost.Hana_SOURCE_DIR@/doc/footer.html
HTML_EXTRA_STYLESHEET   =
HTML_EXTRA_FILES        = @Boost.Hana_SOURCE_DIR@/doc/js/chart.js \
                          @Boost.Hana_SOURCE_DIR@/doc/js/hana.js \
                          @Boost.Hana_SOURCE_DIR@/doc/js/highcharts-data.js \
                          @Boost.Hana_SOURCE_DIR@/doc/js/highcharts-exporting.js \
                          @Boost.Hana_SOURCE_DIR@/doc/js/highcharts.js

HTML_COLORSTYLE_HUE     = 75  # 0 - 359
HTML_COLORSTYLE_SAT     = 100 # 0 - 255
HTML_COLORSTYLE_GAMMA   = 80
HTML_TIMESTAMP          = NO
HTML_DYNAMIC_SECTIONS   = YES
HTML_INDEX_NUM_ENTRIES  = 0 # Fully expand trees in the Indexes by default
DISABLE_INDEX           = YES
GENERATE_TREEVIEW       = @HANA_GENERATE_TREEVIEW@
TREEVIEW_WIDTH          = 270
EXT_LINKS_IN_WINDOW     = NO
FORMULA_FONTSIZE        = 10
FORMULA_TRANSPARENT     = YES
SEARCHENGINE            = @HANA_SEARCHENGINE@

# Mathjax (HTML only)
USE_MATHJAX             = YES
MATHJAX_FORMAT          = HTML-CSS
MATHJAX_RELPATH         = https://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS      =
MATHJAX_CODEFILE        = @Boost.Hana_SOURCE_DIR@/doc/js/mathjax-config.js