libs/hana/doc/Doxyfile.in

   1 # Copyright Louis Dionne 2013-2017
   2 # Distributed under the Boost Software License, Version 1.0.
   3 # (See accompanying file LICENSE.md or copy at http://boost.org/LICENSE_1_0.txt)
   4
   5 PROJECT_NAME            = "Boost.Hana"
   6 PROJECT_BRIEF           = "Your standard library for metaprogramming"
   7 PROJECT_LOGO            = @Boost.Hana_SOURCE_DIR@/doc/icons/Boost.png
   8 PROJECT_NUMBER          = @Boost.Hana_VERSION_STRING@
   9
  10 STRIP_FROM_PATH         = @Boost.Hana_SOURCE_DIR@/include
  11 BUILTIN_STL_SUPPORT     = NO # Allows us to document std:: classes ourselves
  12 STRIP_FROM_INC_PATH     = @Boost.Hana_SOURCE_DIR@/include
  13 ALIASES                 =
  14 ENABLED_SECTIONS        =
  15 QUIET                   = YES
  16
  17 # Resources
  18 OUTPUT_DIRECTORY        = @CMAKE_CURRENT_BINARY_DIR@
  19 INPUT                   = @Boost.Hana_SOURCE_DIR@/include \
  20                           @Boost.Hana_SOURCE_DIR@/doc/tutorial.hpp
  21 FILE_PATTERNS           = *.hpp
  22 RECURSIVE               = YES
  23 EXCLUDE                 =
  24 EXCLUDE_PATTERNS        = *.erb*
  25 EXAMPLE_PATH            = @Boost.Hana_SOURCE_DIR@/example \
  26                           @Boost.Hana_SOURCE_DIR@/test
  27 EXAMPLE_RECURSIVE       = YES
  28 WARN_IF_UNDOCUMENTED    = NO
  29
  30 SHOW_GROUPED_MEMB_INC   = YES
  31 BRIEF_MEMBER_DESC       = YES
  32 REPEAT_BRIEF            = YES
  33 ALWAYS_DETAILED_SEC     = NO
  34 INLINE_INHERITED_MEMB   = NO
  35 JAVADOC_AUTOBRIEF       = YES
  36 QT_AUTOBRIEF            = YES
  37 MULTILINE_CPP_IS_BRIEF  = YES
  38 INHERIT_DOCS            = NO
  39 SEPARATE_MEMBER_PAGES   = NO
  40 DISTRIBUTE_GROUP_DOC    = NO
  41 SUBGROUPING             = NO
  42 INLINE_GROUPED_CLASSES  = NO
  43 INLINE_SIMPLE_STRUCTS   = NO
  44
  45 # Generated formats
  46 GENERATE_HTML           = YES
  47 GENERATE_LATEX          = NO
  48 GENERATE_DOCSET         = @HANA_GENERATE_DOCSET@
  49 DOCSET_BUNDLE_ID        = boost.hana
  50
  51
  52 GENERATE_TODOLIST       = YES
  53 GENERATE_TESTLIST       = YES
  54 GENERATE_BUGLIST        = YES
  55 GENERATE_DEPRECATEDLIST = YES
  56 SHOW_USED_FILES         = NO
  57 SHOW_FILES              = YES
  58 SHOW_NAMESPACES         = YES
  59 LAYOUT_FILE             = @Boost.Hana_SOURCE_DIR@/doc/layout.xml
  60
  61
  62 CLASS_DIAGRAMS          = YES
  63 HAVE_DOT                = NO
  64
  65 HIDE_UNDOC_RELATIONS    = NO
  66 HIDE_UNDOC_MEMBERS      = YES
  67 HIDE_UNDOC_CLASSES      = YES
  68 HIDE_FRIEND_COMPOUNDS   = NO
  69 HIDE_IN_BODY_DOCS       = NO
  70 INTERNAL_DOCS           = YES
  71 HIDE_SCOPE_NAMES        = NO
  72 SHOW_INCLUDE_FILES      = NO
  73 FORCE_LOCAL_INCLUDES    = NO
  74 INLINE_INFO             = NO
  75 SORT_MEMBER_DOCS        = NO
  76 SORT_BRIEF_DOCS         = NO
  77 SORT_MEMBERS_CTORS_1ST  = NO
  78 SORT_GROUP_NAMES        = NO
  79 SORT_BY_SCOPE_NAME      = YES
  80
  81
  82 ALPHABETICAL_INDEX      = NO
  83 COLS_IN_ALPHA_INDEX     = 1
  84
  85 # Preprocessing
  86 ENABLE_PREPROCESSING    = YES
  87 MACRO_EXPANSION         = YES
  88 EXPAND_ONLY_PREDEF      = NO
  89 SEARCH_INCLUDES         = YES
  90 INCLUDE_PATH            = @Boost.Hana_SOURCE_DIR@/include
  91 INCLUDE_FILE_PATTERNS   =
  92 PREDEFINED              = BOOST_HANA_DOXYGEN_INVOKED
  93 SKIP_FUNCTION_MACROS    = NO
  94
  95 # Source browsing
  96 SOURCE_BROWSER          = NO
  97 INLINE_SOURCES          = NO
  98 STRIP_CODE_COMMENTS     = NO
  99 REFERENCED_BY_RELATION  = YES
 100 REFERENCES_RELATION     = YES
 101 REFERENCES_LINK_SOURCE  = YES
 102 USE_HTAGS               = NO
 103 VERBATIM_HEADERS        = NO
 104 # CLANG_ASSISTED_PARSING  = NO
 105 # CLANG_OPTIONS           =
 106
 107 # HTML output
 108 HTML_OUTPUT             = @HANA_HTML_OUTPUT@
 109 HTML_FILE_EXTENSION     = .html
 110 HTML_HEADER             = @Boost.Hana_SOURCE_DIR@/doc/header.html
 111 HTML_FOOTER             = @Boost.Hana_SOURCE_DIR@/doc/footer.html
 112 HTML_EXTRA_STYLESHEET   =
 113 HTML_EXTRA_FILES        = @Boost.Hana_SOURCE_DIR@/doc/js/chart.js \
 114                           @Boost.Hana_SOURCE_DIR@/doc/js/hana.js \
 115                           @Boost.Hana_SOURCE_DIR@/doc/js/highcharts-data.js \
 116                           @Boost.Hana_SOURCE_DIR@/doc/js/highcharts-exporting.js \
 117                           @Boost.Hana_SOURCE_DIR@/doc/js/highcharts.js
 118
 119 HTML_COLORSTYLE_HUE     = 75  # 0 - 359
 120 HTML_COLORSTYLE_SAT     = 100 # 0 - 255
 121 HTML_COLORSTYLE_GAMMA   = 80
 122 HTML_TIMESTAMP          = NO
 123 HTML_DYNAMIC_SECTIONS   = YES
 124 HTML_INDEX_NUM_ENTRIES  = 0 # Fully expand trees in the Indexes by default
 125 DISABLE_INDEX           = YES
 126 GENERATE_TREEVIEW       = @HANA_GENERATE_TREEVIEW@
 127 TREEVIEW_WIDTH          = 270
 128 EXT_LINKS_IN_WINDOW     = NO
 129 FORMULA_FONTSIZE        = 10
 130 FORMULA_TRANSPARENT     = YES
 131 SEARCHENGINE            = @HANA_SEARCHENGINE@
 132
 133 # Mathjax (HTML only)
 134 USE_MATHJAX             = YES
 135 MATHJAX_FORMAT          = HTML-CSS
 136 MATHJAX_RELPATH         = https://cdn.mathjax.org/mathjax/latest
 137 MATHJAX_EXTENSIONS      =
 138 MATHJAX_CODEFILE        = @Boost.Hana_SOURCE_DIR@/doc/js/mathjax-config.js