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