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