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