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