blob: 0f3b5272acc472be5d823159c0b14c4e6a842e50 [file] [log] [blame]
Jean-Marc Valin879fbfd2008-02-20 17:17:13 +11001# Doxyfile 1.5.3
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = CELT
Jean-Marc Valina3803a92009-10-24 11:24:34 -04008PROJECT_NUMBER = 0.7.0
Jean-Marc Valin879fbfd2008-02-20 17:17:13 +11009OUTPUT_DIRECTORY = doc/API
10CREATE_SUBDIRS = NO
11OUTPUT_LANGUAGE = English
12BRIEF_MEMBER_DESC = YES
13REPEAT_BRIEF = YES
14ABBREVIATE_BRIEF = "The $name class " \
15 "The $name widget " \
16 "The $name file " \
17 is \
18 provides \
19 specifies \
20 contains \
21 represents \
22 a \
23 an \
24 the
25ALWAYS_DETAILED_SEC = NO
26INLINE_INHERITED_MEMB = NO
27FULL_PATH_NAMES = YES
28STRIP_FROM_PATH =
29STRIP_FROM_INC_PATH =
30SHORT_NAMES = NO
31JAVADOC_AUTOBRIEF = NO
32QT_AUTOBRIEF = NO
33MULTILINE_CPP_IS_BRIEF = NO
34DETAILS_AT_TOP = NO
35INHERIT_DOCS = YES
36SEPARATE_MEMBER_PAGES = NO
37TAB_SIZE = 8
38ALIASES =
39OPTIMIZE_OUTPUT_FOR_C = YES
40OPTIMIZE_OUTPUT_JAVA = NO
41BUILTIN_STL_SUPPORT = NO
42CPP_CLI_SUPPORT = NO
43DISTRIBUTE_GROUP_DOC = NO
44SUBGROUPING = YES
45#---------------------------------------------------------------------------
46# Build related configuration options
47#---------------------------------------------------------------------------
48EXTRACT_ALL = NO
49EXTRACT_PRIVATE = NO
50EXTRACT_STATIC = NO
51EXTRACT_LOCAL_CLASSES = YES
52EXTRACT_LOCAL_METHODS = NO
53EXTRACT_ANON_NSPACES = NO
54HIDE_UNDOC_MEMBERS = YES
55HIDE_UNDOC_CLASSES = YES
56HIDE_FRIEND_COMPOUNDS = NO
57HIDE_IN_BODY_DOCS = NO
58INTERNAL_DOCS = NO
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
73SHOW_DIRECTORIES = NO
74FILE_VERSION_FILTER =
75#---------------------------------------------------------------------------
76# configuration options related to warning and progress messages
77#---------------------------------------------------------------------------
78QUIET = NO
79WARNINGS = YES
80WARN_IF_UNDOCUMENTED = YES
81WARN_IF_DOC_ERROR = YES
82WARN_NO_PARAMDOC = NO
83WARN_FORMAT = "$file:$line: $text "
84WARN_LOGFILE =
85#---------------------------------------------------------------------------
86# configuration options related to the input files
87#---------------------------------------------------------------------------
88INPUT = libcelt/celt.h \
89 libcelt/celt_types.h \
90 libcelt/celt_header.h
91INPUT_ENCODING = UTF-8
92FILE_PATTERNS = *.c \
93 *.cc \
94 *.cxx \
95 *.cpp \
96 *.c++ \
97 *.d \
98 *.java \
99 *.ii \
100 *.ixx \
101 *.ipp \
102 *.i++ \
103 *.inl \
104 *.h \
105 *.hh \
106 *.hxx \
107 *.hpp \
108 *.h++ \
109 *.idl \
110 *.odl \
111 *.cs \
112 *.php \
113 *.php3 \
114 *.inc \
115 *.m \
116 *.mm \
117 *.dox \
118 *.py \
119 *.C \
120 *.CC \
121 *.C++ \
122 *.II \
123 *.I++ \
124 *.H \
125 *.HH \
126 *.H++ \
127 *.CS \
128 *.PHP \
129 *.PHP3 \
130 *.M \
131 *.MM \
132 *.PY
133RECURSIVE = NO
134EXCLUDE =
135EXCLUDE_SYMLINKS = NO
136EXCLUDE_PATTERNS = *.c
137EXCLUDE_SYMBOLS =
138EXAMPLE_PATH =
139EXAMPLE_PATTERNS = *
140EXAMPLE_RECURSIVE = NO
141IMAGE_PATH =
142INPUT_FILTER =
143FILTER_PATTERNS =
144FILTER_SOURCE_FILES = NO
145#---------------------------------------------------------------------------
146# configuration options related to source browsing
147#---------------------------------------------------------------------------
148SOURCE_BROWSER = YES
149INLINE_SOURCES = NO
150STRIP_CODE_COMMENTS = YES
151REFERENCED_BY_RELATION = YES
152REFERENCES_RELATION = YES
153REFERENCES_LINK_SOURCE = YES
154USE_HTAGS = NO
155VERBATIM_HEADERS = YES
156#---------------------------------------------------------------------------
157# configuration options related to the alphabetical class index
158#---------------------------------------------------------------------------
159ALPHABETICAL_INDEX = NO
160COLS_IN_ALPHA_INDEX = 5
161IGNORE_PREFIX =
162#---------------------------------------------------------------------------
163# configuration options related to the HTML output
164#---------------------------------------------------------------------------
165GENERATE_HTML = YES
166HTML_OUTPUT = html
167HTML_FILE_EXTENSION = .html
168HTML_HEADER =
169HTML_FOOTER =
170HTML_STYLESHEET =
171HTML_ALIGN_MEMBERS = YES
172GENERATE_HTMLHELP = NO
173HTML_DYNAMIC_SECTIONS = NO
174CHM_FILE =
175HHC_LOCATION =
176GENERATE_CHI = NO
177BINARY_TOC = NO
178TOC_EXPAND = NO
179DISABLE_INDEX = NO
180ENUM_VALUES_PER_LINE = 4
181GENERATE_TREEVIEW = NO
182TREEVIEW_WIDTH = 250
183#---------------------------------------------------------------------------
184# configuration options related to the LaTeX output
185#---------------------------------------------------------------------------
186GENERATE_LATEX = YES
187LATEX_OUTPUT = latex
188LATEX_CMD_NAME = latex
189MAKEINDEX_CMD_NAME = makeindex
190COMPACT_LATEX = NO
191PAPER_TYPE = a4wide
192EXTRA_PACKAGES =
193LATEX_HEADER =
194PDF_HYPERLINKS = YES
195USE_PDFLATEX = YES
196LATEX_BATCHMODE = NO
197LATEX_HIDE_INDICES = NO
198#---------------------------------------------------------------------------
199# configuration options related to the RTF output
200#---------------------------------------------------------------------------
201GENERATE_RTF = NO
202RTF_OUTPUT = rtf
203COMPACT_RTF = NO
204RTF_HYPERLINKS = NO
205RTF_STYLESHEET_FILE =
206RTF_EXTENSIONS_FILE =
207#---------------------------------------------------------------------------
208# configuration options related to the man page output
209#---------------------------------------------------------------------------
210GENERATE_MAN = YES
211MAN_OUTPUT = man
212MAN_EXTENSION = .3
213MAN_LINKS = NO
214#---------------------------------------------------------------------------
215# configuration options related to the XML output
216#---------------------------------------------------------------------------
217GENERATE_XML = NO
218XML_OUTPUT = xml
219XML_SCHEMA =
220XML_DTD =
221XML_PROGRAMLISTING = YES
222#---------------------------------------------------------------------------
223# configuration options for the AutoGen Definitions output
224#---------------------------------------------------------------------------
225GENERATE_AUTOGEN_DEF = NO
226#---------------------------------------------------------------------------
227# configuration options related to the Perl module output
228#---------------------------------------------------------------------------
229GENERATE_PERLMOD = NO
230PERLMOD_LATEX = NO
231PERLMOD_PRETTY = YES
232PERLMOD_MAKEVAR_PREFIX =
233#---------------------------------------------------------------------------
234# Configuration options related to the preprocessor
235#---------------------------------------------------------------------------
236ENABLE_PREPROCESSING = YES
237MACRO_EXPANSION = NO
238EXPAND_ONLY_PREDEF = NO
239SEARCH_INCLUDES = YES
240INCLUDE_PATH =
241INCLUDE_FILE_PATTERNS =
242PREDEFINED =
243EXPAND_AS_DEFINED =
244SKIP_FUNCTION_MACROS = YES
245#---------------------------------------------------------------------------
246# Configuration::additions related to external references
247#---------------------------------------------------------------------------
248TAGFILES =
249GENERATE_TAGFILE =
250ALLEXTERNALS = NO
251EXTERNAL_GROUPS = YES
252PERL_PATH = /usr/bin/perl
253#---------------------------------------------------------------------------
254# Configuration options related to the dot tool
255#---------------------------------------------------------------------------
256CLASS_DIAGRAMS = NO
257MSCGEN_PATH =
258HIDE_UNDOC_RELATIONS = YES
259HAVE_DOT = YES
260CLASS_GRAPH = YES
261COLLABORATION_GRAPH = YES
262GROUP_GRAPHS = YES
263UML_LOOK = NO
264TEMPLATE_RELATIONS = NO
265INCLUDE_GRAPH = NO
266INCLUDED_BY_GRAPH = NO
267CALL_GRAPH = NO
268CALLER_GRAPH = NO
269GRAPHICAL_HIERARCHY = YES
270DIRECTORY_GRAPH = YES
271DOT_IMAGE_FORMAT = png
272DOT_PATH =
273DOTFILE_DIRS =
274DOT_GRAPH_MAX_NODES = 50
275MAX_DOT_GRAPH_DEPTH = 1000
276DOT_TRANSPARENT = NO
277DOT_MULTI_TARGETS = NO
278GENERATE_LEGEND = YES
279DOT_CLEANUP = YES
280#---------------------------------------------------------------------------
281# Configuration::additions related to the search engine
282#---------------------------------------------------------------------------
283SEARCHENGINE = NO