icuSources/Doxyfile.in

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