icuSources/Doxyfile.in

   1 # Doxyfile 1.3.7
   2 #  ********************************************************************
   3 #  * COPYRIGHT:
   4 #  * Copyright (c) 2004, 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                = "draft=\par ICU_Draft:\n" \
  33                          "stable=\par ICU_Stable:\n" \
  34                          "deprecated=\par ICU_Deprecated:\n" \
  35                          "obsolete=\par ICU_Obsolete:\n" \
  36                          "internal=\par ICU_Internal:\n"
  37 OPTIMIZE_OUTPUT_FOR_C  = YES
  38 OPTIMIZE_OUTPUT_JAVA   = NO
  39 SUBGROUPING            = YES
  40 #---------------------------------------------------------------------------
  41 # Build related configuration options
  42 #---------------------------------------------------------------------------
  43 EXTRACT_ALL            = NO
  44 EXTRACT_PRIVATE        = NO
  45 EXTRACT_STATIC         = NO
  46 EXTRACT_LOCAL_CLASSES  = YES
  47 EXTRACT_LOCAL_METHODS  = NO
  48 HIDE_UNDOC_MEMBERS     = NO
  49 HIDE_UNDOC_CLASSES     = NO
  50 HIDE_FRIEND_COMPOUNDS  = NO
  51 HIDE_IN_BODY_DOCS      = NO
  52 INTERNAL_DOCS          = YES
  53 CASE_SENSE_NAMES       = YES
  54 HIDE_SCOPE_NAMES       = NO
  55 SHOW_INCLUDE_FILES     = YES
  56 INLINE_INFO            = YES
  57 SORT_MEMBER_DOCS       = YES
  58 SORT_BRIEF_DOCS        = NO
  59 SORT_BY_SCOPE_NAME     = NO
  60 GENERATE_TODOLIST      = YES
  61 GENERATE_TESTLIST      = YES
  62 GENERATE_BUGLIST       = YES
  63 GENERATE_DEPRECATEDLIST= YES
  64 ENABLED_SECTIONS       =
  65 MAX_INITIALIZER_LINES  = 30
  66 SHOW_USED_FILES        = YES
  67 #---------------------------------------------------------------------------
  68 # configuration options related to warning and progress messages
  69 #---------------------------------------------------------------------------
  70 QUIET                  = NO
  71 WARNINGS               = YES
  72 WARN_IF_UNDOCUMENTED   = YES
  73 WARN_IF_DOC_ERROR      = YES
  74 WARN_FORMAT            = "$file:$line: $text"
  75 WARN_LOGFILE           =
  76 #---------------------------------------------------------------------------
  77 # configuration options related to the input files
  78 #---------------------------------------------------------------------------
  79 INPUT                  = ./common/unicode/platform.h @srcdir@/common/unicode @srcdir@/i18n/unicode @srcdir@/io/unicode @srcdir@/layout/unicode
  80 FILE_PATTERNS          = *.h
  81 RECURSIVE              = NO
  82 EXCLUDE                = @srcdir@/common/unicode/urename.h
  83 EXCLUDE_SYMLINKS       = NO
  84 EXCLUDE_PATTERNS       = config*.h
  85 EXAMPLE_PATH           =
  86 EXAMPLE_PATTERNS       =
  87 EXAMPLE_RECURSIVE      = NO
  88 IMAGE_PATH             =
  89 INPUT_FILTER           =
  90 FILTER_SOURCE_FILES    = NO
  91 #---------------------------------------------------------------------------
  92 # configuration options related to source browsing
  93 #---------------------------------------------------------------------------
  94 SOURCE_BROWSER         = YES
  95 INLINE_SOURCES         = NO
  96 STRIP_CODE_COMMENTS    = YES
  97 REFERENCED_BY_RELATION = YES
  98 REFERENCES_RELATION    = YES
  99 VERBATIM_HEADERS       = YES
 100 #---------------------------------------------------------------------------
 101 # configuration options related to the alphabetical class index
 102 #---------------------------------------------------------------------------
 103 ALPHABETICAL_INDEX     = YES
 104 COLS_IN_ALPHA_INDEX    = 5
 105 IGNORE_PREFIX          =
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the HTML output
 108 #---------------------------------------------------------------------------
 109 GENERATE_HTML          = YES
 110 HTML_OUTPUT            = html
 111 HTML_FILE_EXTENSION    = .html
 112 HTML_HEADER            =
 113 HTML_FOOTER            =
 114 HTML_STYLESHEET        =
 115 HTML_ALIGN_MEMBERS     = YES
 116 GENERATE_HTMLHELP      = NO
 117 CHM_FILE               =
 118 HHC_LOCATION           =
 119 GENERATE_CHI           = NO
 120 BINARY_TOC             = NO
 121 TOC_EXPAND             = NO
 122 DISABLE_INDEX          = NO
 123 ENUM_VALUES_PER_LINE   = 4
 124 GENERATE_TREEVIEW      = NO
 125 TREEVIEW_WIDTH         = 250
 126 #---------------------------------------------------------------------------
 127 # configuration options related to the LaTeX output
 128 #---------------------------------------------------------------------------
 129 GENERATE_LATEX         = NO
 130 LATEX_OUTPUT           = latex
 131 LATEX_CMD_NAME         = latex
 132 MAKEINDEX_CMD_NAME     = makeindex
 133 COMPACT_LATEX          = NO
 134 PAPER_TYPE             = a4wide
 135 EXTRA_PACKAGES         =
 136 LATEX_HEADER           =
 137 PDF_HYPERLINKS         = NO
 138 USE_PDFLATEX           = NO
 139 LATEX_BATCHMODE        = NO
 140 LATEX_HIDE_INDICES     = NO
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the RTF output
 143 #---------------------------------------------------------------------------
 144 GENERATE_RTF           = NO
 145 RTF_OUTPUT             = rtf
 146 COMPACT_RTF            = NO
 147 RTF_HYPERLINKS         = NO
 148 RTF_STYLESHEET_FILE    =
 149 RTF_EXTENSIONS_FILE    =
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the man page output
 152 #---------------------------------------------------------------------------
 153 GENERATE_MAN           = NO
 154 MAN_OUTPUT             = man
 155 MAN_EXTENSION          = .3
 156 MAN_LINKS              = NO
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the XML output
 159 #---------------------------------------------------------------------------
 160 GENERATE_XML           = NO
 161 XML_OUTPUT             = xml
 162 XML_SCHEMA             =
 163 XML_DTD                =
 164 XML_PROGRAMLISTING     = YES
 165 #---------------------------------------------------------------------------
 166 # configuration options for the AutoGen Definitions output
 167 #---------------------------------------------------------------------------
 168 GENERATE_AUTOGEN_DEF   = NO
 169 #---------------------------------------------------------------------------
 170 # configuration options related to the Perl module output
 171 #---------------------------------------------------------------------------
 172 GENERATE_PERLMOD       = NO
 173 PERLMOD_LATEX          = YES
 174 PERLMOD_PRETTY         = YES
 175 PERLMOD_MAKEVAR_PREFIX =
 176 #---------------------------------------------------------------------------
 177 # Configuration options related to the preprocessor
 178 #---------------------------------------------------------------------------
 179 ENABLE_PREPROCESSING   = YES
 180 MACRO_EXPANSION        = NO
 181 EXPAND_ONLY_PREDEF     = NO
 182 SEARCH_INCLUDES        = YES
 183 INCLUDE_PATH           =
 184 INCLUDE_FILE_PATTERNS  =
 185 PREDEFINED             =
 186 EXPAND_AS_DEFINED      =
 187 SKIP_FUNCTION_MACROS   = YES
 188 #---------------------------------------------------------------------------
 189 # Configuration::additions related to external references
 190 #---------------------------------------------------------------------------
 191 TAGFILES               =
 192 GENERATE_TAGFILE       =
 193 ALLEXTERNALS           = NO
 194 EXTERNAL_GROUPS        = YES
 195 PERL_PATH              = /usr/bin/perl
 196 #---------------------------------------------------------------------------
 197 # Configuration options related to the dot tool
 198 #---------------------------------------------------------------------------
 199 CLASS_DIAGRAMS         = YES
 200 HIDE_UNDOC_RELATIONS   = YES
 201 HAVE_DOT               = NO
 202 CLASS_GRAPH            = YES
 203 COLLABORATION_GRAPH    = YES
 204 UML_LOOK               = NO
 205 TEMPLATE_RELATIONS     = NO
 206 INCLUDE_GRAPH          = YES
 207 INCLUDED_BY_GRAPH      = YES
 208 CALL_GRAPH             = NO
 209 GRAPHICAL_HIERARCHY    = YES
 210 DOT_IMAGE_FORMAT       = png
 211 DOT_PATH               =
 212 DOTFILE_DIRS           =
 213 MAX_DOT_GRAPH_WIDTH    = 1024
 214 MAX_DOT_GRAPH_HEIGHT   = 1024
 215 MAX_DOT_GRAPH_DEPTH    = 0
 216 GENERATE_LEGEND        = YES
 217 DOT_CLEANUP            = YES
 218 #---------------------------------------------------------------------------
 219 # Configuration::additions related to the search engine
 220 #---------------------------------------------------------------------------
 221 SEARCHENGINE           = NO
 222 CGI_NAME               = search.cgi