]> git.saurik.com Git - apple/icu.git/blame - icuSources/Doxyfile.in
ICU-400.38.tar.gz
[apple/icu.git] / icuSources / Doxyfile.in
CommitLineData
374ca955 1# Doxyfile 1.3.7
b75a7d8f
A
2# ********************************************************************
3# * COPYRIGHT:
46f4442e 4# * Copyright (c) 2004-2008, 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 32ALIASES = "memo=\par Note:\n" \
46f4442e
A
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."
73c04bcf 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
46f4442e
A
70
71# docset
72GENERATE_DOCSET = NO
73DOCSET_FEEDNAME = "ICU @VERSION@"
74DOCSET_BUNDLE_ID = org.icu-project.icu4c
75
b75a7d8f
A
76#---------------------------------------------------------------------------
77# configuration options related to warning and progress messages
78#---------------------------------------------------------------------------
b75a7d8f 79QUIET = NO
b75a7d8f 80WARNINGS = YES
b75a7d8f 81WARN_IF_UNDOCUMENTED = YES
374ca955 82WARN_IF_DOC_ERROR = YES
b75a7d8f 83WARN_FORMAT = "$file:$line: $text"
b75a7d8f 84WARN_LOGFILE =
b75a7d8f
A
85#---------------------------------------------------------------------------
86# configuration options related to the input files
87#---------------------------------------------------------------------------
73c04bcf 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
374ca955 89FILE_PATTERNS = *.h
b75a7d8f 90RECURSIVE = NO
73c04bcf 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
374ca955
A
92EXCLUDE_SYMLINKS = NO
93EXCLUDE_PATTERNS = config*.h
b75a7d8f 94EXAMPLE_PATH =
b75a7d8f 95EXAMPLE_PATTERNS =
374ca955 96EXAMPLE_RECURSIVE = NO
b75a7d8f 97IMAGE_PATH =
b75a7d8f 98INPUT_FILTER =
b75a7d8f 99FILTER_SOURCE_FILES = NO
374ca955
A
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
b75a7d8f
A
109#---------------------------------------------------------------------------
110# configuration options related to the alphabetical class index
111#---------------------------------------------------------------------------
b75a7d8f 112ALPHABETICAL_INDEX = YES
b75a7d8f 113COLS_IN_ALPHA_INDEX = 5
b75a7d8f 114IGNORE_PREFIX =
b75a7d8f
A
115#---------------------------------------------------------------------------
116# configuration options related to the HTML output
117#---------------------------------------------------------------------------
b75a7d8f 118GENERATE_HTML = YES
b75a7d8f 119HTML_OUTPUT = html
374ca955 120HTML_FILE_EXTENSION = .html
b75a7d8f 121HTML_HEADER =
b75a7d8f 122HTML_FOOTER =
b75a7d8f 123HTML_STYLESHEET =
b75a7d8f 124HTML_ALIGN_MEMBERS = YES
b75a7d8f 125GENERATE_HTMLHELP = NO
374ca955
A
126CHM_FILE =
127HHC_LOCATION =
b75a7d8f 128GENERATE_CHI = NO
b75a7d8f 129BINARY_TOC = NO
b75a7d8f 130TOC_EXPAND = NO
b75a7d8f 131DISABLE_INDEX = NO
b75a7d8f 132ENUM_VALUES_PER_LINE = 4
b75a7d8f 133GENERATE_TREEVIEW = NO
b75a7d8f 134TREEVIEW_WIDTH = 250
b75a7d8f
A
135#---------------------------------------------------------------------------
136# configuration options related to the LaTeX output
137#---------------------------------------------------------------------------
b75a7d8f 138GENERATE_LATEX = NO
b75a7d8f 139LATEX_OUTPUT = latex
374ca955
A
140LATEX_CMD_NAME = latex
141MAKEINDEX_CMD_NAME = makeindex
b75a7d8f 142COMPACT_LATEX = NO
b75a7d8f 143PAPER_TYPE = a4wide
b75a7d8f 144EXTRA_PACKAGES =
b75a7d8f 145LATEX_HEADER =
b75a7d8f 146PDF_HYPERLINKS = NO
b75a7d8f 147USE_PDFLATEX = NO
b75a7d8f 148LATEX_BATCHMODE = NO
374ca955 149LATEX_HIDE_INDICES = NO
b75a7d8f
A
150#---------------------------------------------------------------------------
151# configuration options related to the RTF output
152#---------------------------------------------------------------------------
b75a7d8f 153GENERATE_RTF = NO
b75a7d8f 154RTF_OUTPUT = rtf
b75a7d8f 155COMPACT_RTF = NO
b75a7d8f 156RTF_HYPERLINKS = NO
b75a7d8f 157RTF_STYLESHEET_FILE =
374ca955 158RTF_EXTENSIONS_FILE =
b75a7d8f
A
159#---------------------------------------------------------------------------
160# configuration options related to the man page output
161#---------------------------------------------------------------------------
b75a7d8f 162GENERATE_MAN = NO
b75a7d8f 163MAN_OUTPUT = man
b75a7d8f 164MAN_EXTENSION = .3
374ca955
A
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#---------------------------------------------------------------------------
73c04bcf 181GENERATE_PERLMOD = NO
374ca955
A
182PERLMOD_LATEX = YES
183PERLMOD_PRETTY = YES
184PERLMOD_MAKEVAR_PREFIX =
b75a7d8f
A
185#---------------------------------------------------------------------------
186# Configuration options related to the preprocessor
187#---------------------------------------------------------------------------
b75a7d8f 188ENABLE_PREPROCESSING = YES
73c04bcf
A
189MACRO_EXPANSION = YES
190EXPAND_ONLY_PREDEF = YES
b75a7d8f 191SEARCH_INCLUDES = YES
b75a7d8f 192INCLUDE_PATH =
b75a7d8f 193INCLUDE_FILE_PATTERNS =
73c04bcf 194PREDEFINED = U_EXPORT2 U_STABLE U_DRAFT U_INTERNAL U_SYSTEM U_DEPRECATED U_OBSOLETE
b75a7d8f 195EXPAND_AS_DEFINED =
374ca955 196SKIP_FUNCTION_MACROS = YES
b75a7d8f 197#---------------------------------------------------------------------------
374ca955 198# Configuration::additions related to external references
b75a7d8f 199#---------------------------------------------------------------------------
b75a7d8f 200TAGFILES =
73c04bcf 201GENERATE_TAGFILE = "@srcdir@/doc/html/icudocs.tag"
b75a7d8f 202ALLEXTERNALS = NO
374ca955 203EXTERNAL_GROUPS = YES
b75a7d8f 204PERL_PATH = /usr/bin/perl
b75a7d8f
A
205#---------------------------------------------------------------------------
206# Configuration options related to the dot tool
207#---------------------------------------------------------------------------
374ca955
A
208CLASS_DIAGRAMS = YES
209HIDE_UNDOC_RELATIONS = YES
b75a7d8f 210HAVE_DOT = NO
b75a7d8f 211CLASS_GRAPH = YES
b75a7d8f 212COLLABORATION_GRAPH = YES
374ca955
A
213UML_LOOK = NO
214TEMPLATE_RELATIONS = NO
b75a7d8f 215INCLUDE_GRAPH = YES
b75a7d8f 216INCLUDED_BY_GRAPH = YES
374ca955 217CALL_GRAPH = NO
b75a7d8f 218GRAPHICAL_HIERARCHY = YES
374ca955 219DOT_IMAGE_FORMAT = png
b75a7d8f 220DOT_PATH =
374ca955 221DOTFILE_DIRS =
b75a7d8f 222MAX_DOT_GRAPH_WIDTH = 1024
b75a7d8f 223MAX_DOT_GRAPH_HEIGHT = 1024
374ca955 224MAX_DOT_GRAPH_DEPTH = 0
b75a7d8f 225GENERATE_LEGEND = YES
b75a7d8f 226DOT_CLEANUP = YES
b75a7d8f 227#---------------------------------------------------------------------------
374ca955 228# Configuration::additions related to the search engine
b75a7d8f 229#---------------------------------------------------------------------------
73c04bcf 230SEARCHENGINE = YES