source/Doxyfile.in

   1 # Doxyfile 1.3.7
   2 # Copyright (C) 2016 and later: Unicode, Inc. and others.
   3 # License & terms of use: http://www.unicode.org/copyright.html
   4 #  ********************************************************************
   5 #  * COPYRIGHT:
   6 #  * Copyright (c) 2004-2015, International Business Machines Corporation
   7 #  * and others. All Rights Reserved.
   8 #  ********************************************************************
   9
  10 #---------------------------------------------------------------------------
  11 # Project related configuration options
  12 #---------------------------------------------------------------------------
  13 PROJECT_NAME           = "ICU @VERSION@"
  14 PROJECT_NUMBER         = @VERSION@
  15 OUTPUT_DIRECTORY       = doc
  16 CREATE_SUBDIRS         = NO
  17 OUTPUT_LANGUAGE        = English
  18 #USE_WINDOWS_ENCODING   = YES
  19 DOXYFILE_ENCODING       = UTF-8
  20 BRIEF_MEMBER_DESC      = YES
  21 REPEAT_BRIEF           = YES
  22 ABBREVIATE_BRIEF       =
  23 ALWAYS_DETAILED_SEC    = NO
  24 INLINE_INHERITED_MEMB  = NO
  25 FULL_PATH_NAMES        = NO
  26 STRIP_FROM_PATH        =
  27 STRIP_FROM_INC_PATH    =
  28 SHORT_NAMES            = NO
  29 JAVADOC_AUTOBRIEF      = YES
  30 MULTILINE_CPP_IS_BRIEF = NO
  31 #DETAILS_AT_TOP         = NO
  32 INHERIT_DOCS           = YES
  33 DISTRIBUTE_GROUP_DOC   = YES
  34 TAB_SIZE               = 8
  35 ALIASES                = "memo=\par Note:\n" \
  36                          "draft=\xrefitem draft \"Draft\" \"Draft List\"  This API may be changed in the future versions and was introduced in" \
  37                          "stable=\xrefitem stable \"Stable\" \"Stable List\"" \
  38                          "deprecated=\xrefitem deprecated \"Deprecated\" \"Deprecated List\"" \
  39                          "obsolete=\xrefitem obsolete \"Obsolete\" \"Obsolete List\"" \
  40                          "system=\xrefitem system \"System\" \"System List\" \n Do not use unless you know what you are doing." \
  41                          "internal=\xrefitem internal \"Internal\"  \"Internal List\"  Do not use. This API is for internal use only."
  42
  43 OPTIMIZE_OUTPUT_FOR_C  = YES
  44 OPTIMIZE_OUTPUT_JAVA   = NO
  45 SUBGROUPING            = YES
  46 #---------------------------------------------------------------------------
  47 # Build related configuration options
  48 #---------------------------------------------------------------------------
  49 EXTRACT_ALL            = NO
  50 EXTRACT_PRIVATE        = NO
  51 EXTRACT_STATIC         = NO
  52 EXTRACT_LOCAL_CLASSES  = YES
  53 EXTRACT_LOCAL_METHODS  = NO
  54 HIDE_UNDOC_MEMBERS     = NO
  55 HIDE_UNDOC_CLASSES     = NO
  56 HIDE_FRIEND_COMPOUNDS  = NO
  57 HIDE_IN_BODY_DOCS      = NO
  58 INTERNAL_DOCS          = YES
  59 CASE_SENSE_NAMES       = YES
  60 HIDE_SCOPE_NAMES       = NO
  61 SHOW_INCLUDE_FILES     = YES
  62 INLINE_INFO            = YES
  63 SORT_MEMBER_DOCS       = YES
  64 SORT_BRIEF_DOCS        = NO
  65 SORT_BY_SCOPE_NAME     = NO
  66 GENERATE_TODOLIST      = YES
  67 GENERATE_TESTLIST      = YES
  68 GENERATE_BUGLIST       = YES
  69 GENERATE_DEPRECATEDLIST= YES
  70 ENABLED_SECTIONS       =
  71 MAX_INITIALIZER_LINES  = 30
  72 SHOW_USED_FILES        = YES
  73
  74 # docset
  75 GENERATE_DOCSET        = NO
  76 DOCSET_FEEDNAME        = "ICU @VERSION@"
  77 DOCSET_BUNDLE_ID       = org.icu-project.icu4c
  78
  79 #---------------------------------------------------------------------------
  80 # configuration options related to warning and progress messages
  81 #---------------------------------------------------------------------------
  82 QUIET                  = NO
  83 WARNINGS               = YES
  84 WARN_IF_UNDOCUMENTED   = YES
  85 WARN_IF_DOC_ERROR      = YES
  86 WARN_FORMAT            = "$file:$line: $text"
  87 WARN_LOGFILE           =
  88 #---------------------------------------------------------------------------
  89 # configuration options related to the input files
  90 #---------------------------------------------------------------------------
  91 INPUT                  = @srcdir@/common/unicode @srcdir@/i18n/unicode @srcdir@/io/unicode @srcdir@/layout/LEFontInstance.h @srcdir@/layout/LEGlyphStorage.h @srcdir@/layout/LELanguages.h @srcdir@/layout/LEScripts.h @srcdir@/layout/LESwaps.h @srcdir@/layout/LETypes.h @srcdir@/layout/LayoutEngine.h @srcdir@/layoutex/layout
  92 FILE_PATTERNS          = *.h
  93 RECURSIVE              = NO
  94 EXCLUDE                = @srcdir@/common/unicode/urename.h @srcdir@/common/unicode/udraft.h @srcdir@/common/unicode/udeprctd.h @srcdir@/common/unicode/uobslete.h @srcdir@/common/unicode/ppalmos.h
  95 EXCLUDE_SYMLINKS       = NO
  96 EXCLUDE_PATTERNS       = config*.h
  97 EXAMPLE_PATH           = @srcdir@/
  98 EXAMPLE_PATTERNS       =
  99 EXAMPLE_RECURSIVE      = NO
 100 IMAGE_PATH             =
 101 INPUT_FILTER           =
 102 FILTER_SOURCE_FILES    = NO
 103 #---------------------------------------------------------------------------
 104 # configuration options related to source browsing
 105 #---------------------------------------------------------------------------
 106 SOURCE_BROWSER         = YES
 107 INLINE_SOURCES         = NO
 108 STRIP_CODE_COMMENTS    = YES
 109 REFERENCED_BY_RELATION = YES
 110 REFERENCES_RELATION    = YES
 111 VERBATIM_HEADERS       = YES
 112 #---------------------------------------------------------------------------
 113 # configuration options related to the alphabetical class index
 114 #---------------------------------------------------------------------------
 115 ALPHABETICAL_INDEX     = YES
 116 COLS_IN_ALPHA_INDEX    = 5
 117 IGNORE_PREFIX          =
 118 #---------------------------------------------------------------------------
 119 # configuration options related to the HTML output
 120 #---------------------------------------------------------------------------
 121 GENERATE_HTML          = YES
 122 HTML_OUTPUT            = html
 123 HTML_FILE_EXTENSION    = .html
 124 HTML_HEADER            =
 125 HTML_FOOTER            =
 126 HTML_STYLESHEET        =
 127 HTML_ALIGN_MEMBERS     = YES
 128 GENERATE_HTMLHELP      = NO
 129 CHM_FILE               =
 130 HHC_LOCATION           =
 131 GENERATE_CHI           = NO
 132 BINARY_TOC             = NO
 133 TOC_EXPAND             = NO
 134 DISABLE_INDEX          = NO
 135 ENUM_VALUES_PER_LINE   = 4
 136 GENERATE_TREEVIEW      = NO
 137 TREEVIEW_WIDTH         = 250
 138 #---------------------------------------------------------------------------
 139 # configuration options related to the LaTeX output
 140 #---------------------------------------------------------------------------
 141 GENERATE_LATEX         = NO
 142 LATEX_OUTPUT           = latex
 143 LATEX_CMD_NAME         = latex
 144 MAKEINDEX_CMD_NAME     = makeindex
 145 COMPACT_LATEX          = NO
 146 PAPER_TYPE             = a4wide
 147 EXTRA_PACKAGES         =
 148 LATEX_HEADER           =
 149 PDF_HYPERLINKS         = NO
 150 USE_PDFLATEX           = NO
 151 LATEX_BATCHMODE        = NO
 152 LATEX_HIDE_INDICES     = NO
 153 #---------------------------------------------------------------------------
 154 # configuration options related to the RTF output
 155 #---------------------------------------------------------------------------
 156 GENERATE_RTF           = NO
 157 RTF_OUTPUT             = rtf
 158 COMPACT_RTF            = NO
 159 RTF_HYPERLINKS         = NO
 160 RTF_STYLESHEET_FILE    =
 161 RTF_EXTENSIONS_FILE    =
 162 #---------------------------------------------------------------------------
 163 # configuration options related to the man page output
 164 #---------------------------------------------------------------------------
 165 GENERATE_MAN           = NO
 166 MAN_OUTPUT             = man
 167 MAN_EXTENSION          = .3
 168 MAN_LINKS              = NO
 169 #---------------------------------------------------------------------------
 170 # configuration options related to the XML output
 171 #---------------------------------------------------------------------------
 172 GENERATE_XML           = NO
 173 XML_OUTPUT             = xml
 174 XML_SCHEMA             =
 175 XML_DTD                =
 176 XML_PROGRAMLISTING     = YES
 177 #---------------------------------------------------------------------------
 178 # configuration options for the AutoGen Definitions output
 179 #---------------------------------------------------------------------------
 180 GENERATE_AUTOGEN_DEF   = NO
 181 #---------------------------------------------------------------------------
 182 # configuration options related to the Perl module output
 183 #---------------------------------------------------------------------------
 184 GENERATE_PERLMOD       = NO
 185 PERLMOD_LATEX          = YES
 186 PERLMOD_PRETTY         = YES
 187 PERLMOD_MAKEVAR_PREFIX =
 188 #---------------------------------------------------------------------------
 189 # Configuration options related to the preprocessor
 190 #---------------------------------------------------------------------------
 191 ENABLE_PREPROCESSING   = YES
 192 MACRO_EXPANSION        = YES
 193 EXPAND_ONLY_PREDEF     = YES
 194 SEARCH_INCLUDES        = YES
 195 INCLUDE_PATH           =
 196 INCLUDE_FILE_PATTERNS  =
 197 PREDEFINED             = U_EXPORT2= U_STABLE= U_DRAFT= U_INTERNAL= U_SYSTEM= U_DEPRECATED= U_OBSOLETE= U_CALLCONV= U_CDECL_BEGIN= U_CDECL_END=  U_NO_THROW=\ "U_NAMESPACE_BEGIN=namespace icu{" "U_NAMESPACE_END=}" U_HAVE_STD_STRING=1 U_SHOW_CPLUSPLUS_API=1 U_DEFINE_LOCAL_OPEN_POINTER()= U_IN_DOXYGEN=1 U_OVERRIDE= U_FINAL= UCONFIG_ENABLE_PLUGINS=1
 198 EXPAND_AS_DEFINED      =
 199 SKIP_FUNCTION_MACROS   = YES
 200 #---------------------------------------------------------------------------
 201 # Configuration::additions related to external references
 202 #---------------------------------------------------------------------------
 203 TAGFILES               =
 204 GENERATE_TAGFILE       =  "@builddir@/doc/html/icudocs.tag"
 205 ALLEXTERNALS           = NO
 206 EXTERNAL_GROUPS        = YES
 207 PERL_PATH              = /usr/bin/perl
 208 #---------------------------------------------------------------------------
 209 # Configuration options related to the dot tool
 210 #---------------------------------------------------------------------------
 211 CLASS_DIAGRAMS         = YES
 212 HIDE_UNDOC_RELATIONS   = YES
 213 HAVE_DOT               = NO
 214 CLASS_GRAPH            = YES
 215 COLLABORATION_GRAPH    = YES
 216 UML_LOOK               = NO
 217 TEMPLATE_RELATIONS     = NO
 218 INCLUDE_GRAPH          = YES
 219 INCLUDED_BY_GRAPH      = YES
 220 CALL_GRAPH             = NO
 221 CALLER_GRAPH            = NO
 222 GRAPHICAL_HIERARCHY    = YES
 223 DOT_IMAGE_FORMAT       = png
 224 DOT_PATH               =
 225 #DOT_FONTNAME          = FreeSans
 226 DOTFILE_DIRS           =
 227 MAX_DOT_GRAPH_WIDTH    = 1024
 228 MAX_DOT_GRAPH_HEIGHT   = 1024
 229 MAX_DOT_GRAPH_DEPTH    = 0
 230 GENERATE_LEGEND        = YES
 231 DOT_CLEANUP            = YES
 232 #---------------------------------------------------------------------------
 233 # Configuration::additions related to the search engine
 234 #---------------------------------------------------------------------------
 235 SEARCHENGINE           = NO