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