]> git.saurik.com Git - apple/icu.git/blame_incremental - icuSources/Doxyfile.in
ICU-59180.0.1.tar.gz
[apple/icu.git] / icuSources / Doxyfile.in
... / ...
CommitLineData
1# Doxyfile 1.3.7
2# Copyright (C) 2016 and later: Unicode, Inc. and others.
3# License & terms of use: http://www.unicode.org/copyright.html
4# ********************************************************************
5# * COPYRIGHT:
6# * Copyright (c) 2004-2015, International Business Machines Corporation
7# * and others. All Rights Reserved.
8# ********************************************************************
9
10#---------------------------------------------------------------------------
11# Project related configuration options
12#---------------------------------------------------------------------------
13PROJECT_NAME = "ICU @VERSION@"
14PROJECT_NUMBER = @VERSION@
15OUTPUT_DIRECTORY = doc
16CREATE_SUBDIRS = NO
17OUTPUT_LANGUAGE = English
18#USE_WINDOWS_ENCODING = YES
19DOXYFILE_ENCODING = UTF-8
20BRIEF_MEMBER_DESC = YES
21REPEAT_BRIEF = YES
22ABBREVIATE_BRIEF =
23ALWAYS_DETAILED_SEC = NO
24INLINE_INHERITED_MEMB = NO
25FULL_PATH_NAMES = NO
26STRIP_FROM_PATH =
27STRIP_FROM_INC_PATH =
28SHORT_NAMES = NO
29JAVADOC_AUTOBRIEF = YES
30MULTILINE_CPP_IS_BRIEF = NO
31#DETAILS_AT_TOP = NO
32INHERIT_DOCS = YES
33DISTRIBUTE_GROUP_DOC = YES
34TAB_SIZE = 8
35ALIASES = "memo=\par Note:\n" \
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."
42
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
58INTERNAL_DOCS = YES
59CASE_SENSE_NAMES = YES
60HIDE_SCOPE_NAMES = NO
61SHOW_INCLUDE_FILES = YES
62INLINE_INFO = YES
63SORT_MEMBER_DOCS = YES
64SORT_BRIEF_DOCS = NO
65SORT_BY_SCOPE_NAME = NO
66GENERATE_TODOLIST = YES
67GENERATE_TESTLIST = YES
68GENERATE_BUGLIST = YES
69GENERATE_DEPRECATEDLIST= YES
70ENABLED_SECTIONS =
71MAX_INITIALIZER_LINES = 30
72SHOW_USED_FILES = YES
73
74# docset
75GENERATE_DOCSET = NO
76DOCSET_FEEDNAME = "ICU @VERSION@"
77DOCSET_BUNDLE_ID = org.icu-project.icu4c
78
79#---------------------------------------------------------------------------
80# configuration options related to warning and progress messages
81#---------------------------------------------------------------------------
82QUIET = NO
83WARNINGS = YES
84WARN_IF_UNDOCUMENTED = YES
85WARN_IF_DOC_ERROR = YES
86WARN_FORMAT = "$file:$line: $text"
87WARN_LOGFILE =
88#---------------------------------------------------------------------------
89# configuration options related to the input files
90#---------------------------------------------------------------------------
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
92FILE_PATTERNS = *.h
93RECURSIVE = NO
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
95EXCLUDE_SYMLINKS = NO
96EXCLUDE_PATTERNS = config*.h
97EXAMPLE_PATH = @srcdir@/
98EXAMPLE_PATTERNS =
99EXAMPLE_RECURSIVE = NO
100IMAGE_PATH =
101INPUT_FILTER =
102FILTER_SOURCE_FILES = NO
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
112#---------------------------------------------------------------------------
113# configuration options related to the alphabetical class index
114#---------------------------------------------------------------------------
115ALPHABETICAL_INDEX = YES
116COLS_IN_ALPHA_INDEX = 5
117IGNORE_PREFIX =
118#---------------------------------------------------------------------------
119# configuration options related to the HTML output
120#---------------------------------------------------------------------------
121GENERATE_HTML = YES
122HTML_OUTPUT = html
123HTML_FILE_EXTENSION = .html
124HTML_HEADER =
125HTML_FOOTER =
126HTML_STYLESHEET =
127HTML_ALIGN_MEMBERS = YES
128GENERATE_HTMLHELP = NO
129CHM_FILE =
130HHC_LOCATION =
131GENERATE_CHI = NO
132BINARY_TOC = NO
133TOC_EXPAND = NO
134DISABLE_INDEX = NO
135ENUM_VALUES_PER_LINE = 4
136GENERATE_TREEVIEW = NO
137TREEVIEW_WIDTH = 250
138#---------------------------------------------------------------------------
139# configuration options related to the LaTeX output
140#---------------------------------------------------------------------------
141GENERATE_LATEX = NO
142LATEX_OUTPUT = latex
143LATEX_CMD_NAME = latex
144MAKEINDEX_CMD_NAME = makeindex
145COMPACT_LATEX = NO
146PAPER_TYPE = a4wide
147EXTRA_PACKAGES =
148LATEX_HEADER =
149PDF_HYPERLINKS = NO
150USE_PDFLATEX = NO
151LATEX_BATCHMODE = NO
152LATEX_HIDE_INDICES = NO
153#---------------------------------------------------------------------------
154# configuration options related to the RTF output
155#---------------------------------------------------------------------------
156GENERATE_RTF = NO
157RTF_OUTPUT = rtf
158COMPACT_RTF = NO
159RTF_HYPERLINKS = NO
160RTF_STYLESHEET_FILE =
161RTF_EXTENSIONS_FILE =
162#---------------------------------------------------------------------------
163# configuration options related to the man page output
164#---------------------------------------------------------------------------
165GENERATE_MAN = NO
166MAN_OUTPUT = man
167MAN_EXTENSION = .3
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#---------------------------------------------------------------------------
184GENERATE_PERLMOD = NO
185PERLMOD_LATEX = YES
186PERLMOD_PRETTY = YES
187PERLMOD_MAKEVAR_PREFIX =
188#---------------------------------------------------------------------------
189# Configuration options related to the preprocessor
190#---------------------------------------------------------------------------
191ENABLE_PREPROCESSING = YES
192MACRO_EXPANSION = YES
193EXPAND_ONLY_PREDEF = YES
194SEARCH_INCLUDES = YES
195INCLUDE_PATH =
196INCLUDE_FILE_PATTERNS =
197PREDEFINED = 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_SHOW_CPLUSPLUS_API=1 U_DEFINE_LOCAL_OPEN_POINTER()= U_IN_DOXYGEN=1 U_OVERRIDE=override U_FINAL=final UCONFIG_ENABLE_PLUGINS=1 U_CHAR16_IS_TYPEDEF=0 U_CPLUSPLUS_VERSION=11 U_HAVE_RVALUE_REFERENCES=1 U_WCHAR_IS_UTF16
198EXPAND_AS_DEFINED =
199SKIP_FUNCTION_MACROS = YES
200#---------------------------------------------------------------------------
201# Configuration::additions related to external references
202#---------------------------------------------------------------------------
203TAGFILES =
204GENERATE_TAGFILE = "@builddir@/doc/html/icudocs.tag"
205ALLEXTERNALS = NO
206EXTERNAL_GROUPS = YES
207PERL_PATH = /usr/bin/perl
208#---------------------------------------------------------------------------
209# Configuration options related to the dot tool
210#---------------------------------------------------------------------------
211CLASS_DIAGRAMS = YES
212HIDE_UNDOC_RELATIONS = YES
213HAVE_DOT = NO
214CLASS_GRAPH = YES
215COLLABORATION_GRAPH = YES
216UML_LOOK = NO
217TEMPLATE_RELATIONS = NO
218INCLUDE_GRAPH = YES
219INCLUDED_BY_GRAPH = YES
220CALL_GRAPH = NO
221CALLER_GRAPH = NO
222GRAPHICAL_HIERARCHY = YES
223DOT_IMAGE_FORMAT = png
224DOT_PATH =
225#DOT_FONTNAME = FreeSans
226DOTFILE_DIRS =
227MAX_DOT_GRAPH_WIDTH = 1024
228MAX_DOT_GRAPH_HEIGHT = 1024
229MAX_DOT_GRAPH_DEPTH = 0
230GENERATE_LEGEND = YES
231DOT_CLEANUP = YES
232#---------------------------------------------------------------------------
233# Configuration::additions related to the search engine
234#---------------------------------------------------------------------------
235SEARCHENGINE = NO