icuSources/Doxyfile.in

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