xref: /aosp_15_r20/external/speex/Doxyfile (revision 28e138c64d234588b5cd2a8a403b584bd3036e4e)
1# Doxyfile 1.5.1-KDevelop
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME           = Speex
7PROJECT_NUMBER         = 1.2-beta2
8OUTPUT_DIRECTORY       = doc
9CREATE_SUBDIRS         = NO
10OUTPUT_LANGUAGE        = English
11USE_WINDOWS_ENCODING   = NO
12BRIEF_MEMBER_DESC      = YES
13REPEAT_BRIEF           = YES
14ABBREVIATE_BRIEF       =
15ALWAYS_DETAILED_SEC    = NO
16INLINE_INHERITED_MEMB  = NO
17FULL_PATH_NAMES        = NO
18STRIP_FROM_PATH        =
19STRIP_FROM_INC_PATH    =
20SHORT_NAMES            = NO
21JAVADOC_AUTOBRIEF      = NO
22MULTILINE_CPP_IS_BRIEF = NO
23DETAILS_AT_TOP         = NO
24INHERIT_DOCS           = YES
25SEPARATE_MEMBER_PAGES  = NO
26TAB_SIZE               = 8
27ALIASES                =
28OPTIMIZE_OUTPUT_FOR_C  = NO
29OPTIMIZE_OUTPUT_JAVA   = NO
30BUILTIN_STL_SUPPORT    = NO
31DISTRIBUTE_GROUP_DOC   = NO
32SUBGROUPING            = YES
33#---------------------------------------------------------------------------
34# Build related configuration options
35#---------------------------------------------------------------------------
36EXTRACT_ALL            = NO
37EXTRACT_PRIVATE        = NO
38EXTRACT_STATIC         = NO
39EXTRACT_LOCAL_CLASSES  = YES
40EXTRACT_LOCAL_METHODS  = NO
41HIDE_UNDOC_MEMBERS     = NO
42HIDE_UNDOC_CLASSES     = NO
43HIDE_FRIEND_COMPOUNDS  = NO
44HIDE_IN_BODY_DOCS      = NO
45INTERNAL_DOCS          = NO
46CASE_SENSE_NAMES       = YES
47HIDE_SCOPE_NAMES       = NO
48SHOW_INCLUDE_FILES     = YES
49INLINE_INFO            = YES
50SORT_MEMBER_DOCS       = YES
51SORT_BRIEF_DOCS        = NO
52SORT_BY_SCOPE_NAME     = NO
53GENERATE_TODOLIST      = YES
54GENERATE_TESTLIST      = YES
55GENERATE_BUGLIST       = YES
56GENERATE_DEPRECATEDLIST= YES
57ENABLED_SECTIONS       =
58MAX_INITIALIZER_LINES  = 30
59SHOW_USED_FILES        = YES
60SHOW_DIRECTORIES       = YES
61FILE_VERSION_FILTER    =
62#---------------------------------------------------------------------------
63# configuration options related to warning and progress messages
64#---------------------------------------------------------------------------
65QUIET                  = NO
66WARNINGS               = YES
67WARN_IF_UNDOCUMENTED   = YES
68WARN_IF_DOC_ERROR      = YES
69WARN_NO_PARAMDOC       = NO
70WARN_FORMAT            = "$file:$line: $text"
71WARN_LOGFILE           =
72#---------------------------------------------------------------------------
73# configuration options related to the input files
74#---------------------------------------------------------------------------
75INPUT                  = include/speex
76FILE_PATTERNS          =
77RECURSIVE              = NO
78EXCLUDE                =
79EXCLUDE_SYMLINKS       = NO
80EXCLUDE_PATTERNS       = speex_config_types.h
81EXAMPLE_PATH           =
82EXAMPLE_PATTERNS       =
83EXAMPLE_RECURSIVE      = NO
84IMAGE_PATH             =
85INPUT_FILTER           =
86FILTER_PATTERNS        =
87FILTER_SOURCE_FILES    = NO
88#---------------------------------------------------------------------------
89# configuration options related to source browsing
90#---------------------------------------------------------------------------
91SOURCE_BROWSER         = NO
92INLINE_SOURCES         = NO
93STRIP_CODE_COMMENTS    = YES
94REFERENCED_BY_RELATION = YES
95REFERENCES_RELATION    = YES
96REFERENCES_LINK_SOURCE = YES
97USE_HTAGS              = NO
98VERBATIM_HEADERS       = YES
99#---------------------------------------------------------------------------
100# configuration options related to the alphabetical class index
101#---------------------------------------------------------------------------
102ALPHABETICAL_INDEX     = NO
103COLS_IN_ALPHA_INDEX    = 5
104IGNORE_PREFIX          =
105#---------------------------------------------------------------------------
106# configuration options related to the HTML output
107#---------------------------------------------------------------------------
108GENERATE_HTML          = YES
109HTML_OUTPUT            = html
110HTML_FILE_EXTENSION    = .html
111HTML_HEADER            =
112HTML_FOOTER            =
113HTML_STYLESHEET        =
114HTML_ALIGN_MEMBERS     = YES
115GENERATE_HTMLHELP      = NO
116CHM_FILE               =
117HHC_LOCATION           =
118GENERATE_CHI           = NO
119BINARY_TOC             = NO
120TOC_EXPAND             = NO
121DISABLE_INDEX          = NO
122ENUM_VALUES_PER_LINE   = 4
123GENERATE_TREEVIEW      = NO
124TREEVIEW_WIDTH         = 250
125#---------------------------------------------------------------------------
126# configuration options related to the LaTeX output
127#---------------------------------------------------------------------------
128GENERATE_LATEX         = YES
129LATEX_OUTPUT           = latex
130LATEX_CMD_NAME         = latex
131MAKEINDEX_CMD_NAME     = makeindex
132COMPACT_LATEX          = NO
133PAPER_TYPE             = a4wide
134EXTRA_PACKAGES         =
135LATEX_HEADER           =
136PDF_HYPERLINKS         = YES
137USE_PDFLATEX           = YES
138LATEX_BATCHMODE        = NO
139LATEX_HIDE_INDICES     = NO
140#---------------------------------------------------------------------------
141# configuration options related to the RTF output
142#---------------------------------------------------------------------------
143GENERATE_RTF           = NO
144RTF_OUTPUT             = rtf
145COMPACT_RTF            = NO
146RTF_HYPERLINKS         = NO
147RTF_STYLESHEET_FILE    =
148RTF_EXTENSIONS_FILE    =
149#---------------------------------------------------------------------------
150# configuration options related to the man page output
151#---------------------------------------------------------------------------
152GENERATE_MAN           = NO
153MAN_OUTPUT             = man
154MAN_EXTENSION          = .3
155MAN_LINKS              = NO
156#---------------------------------------------------------------------------
157# configuration options related to the XML output
158#---------------------------------------------------------------------------
159GENERATE_XML           = NO
160XML_OUTPUT             = xml
161XML_SCHEMA             =
162XML_DTD                =
163XML_PROGRAMLISTING     = YES
164#---------------------------------------------------------------------------
165# configuration options for the AutoGen Definitions output
166#---------------------------------------------------------------------------
167GENERATE_AUTOGEN_DEF   = NO
168#---------------------------------------------------------------------------
169# configuration options related to the Perl module output
170#---------------------------------------------------------------------------
171GENERATE_PERLMOD       = NO
172PERLMOD_LATEX          = NO
173PERLMOD_PRETTY         = YES
174PERLMOD_MAKEVAR_PREFIX =
175#---------------------------------------------------------------------------
176# Configuration options related to the preprocessor
177#---------------------------------------------------------------------------
178ENABLE_PREPROCESSING   = YES
179MACRO_EXPANSION        = NO
180EXPAND_ONLY_PREDEF     = NO
181SEARCH_INCLUDES        = YES
182INCLUDE_PATH           =
183INCLUDE_FILE_PATTERNS  =
184PREDEFINED             =
185EXPAND_AS_DEFINED      =
186SKIP_FUNCTION_MACROS   = YES
187#---------------------------------------------------------------------------
188# Configuration::additions related to external references
189#---------------------------------------------------------------------------
190TAGFILES               =
191GENERATE_TAGFILE       =
192ALLEXTERNALS           = NO
193EXTERNAL_GROUPS        = YES
194PERL_PATH              = /usr/bin/perl
195#---------------------------------------------------------------------------
196# Configuration options related to the dot tool
197#---------------------------------------------------------------------------
198CLASS_DIAGRAMS         = YES
199HIDE_UNDOC_RELATIONS   = YES
200HAVE_DOT               = NO
201CLASS_GRAPH            = YES
202COLLABORATION_GRAPH    = YES
203GROUP_GRAPHS           = YES
204UML_LOOK               = NO
205TEMPLATE_RELATIONS     = YES
206INCLUDE_GRAPH          = YES
207INCLUDED_BY_GRAPH      = YES
208CALL_GRAPH             = NO
209CALLER_GRAPH           = NO
210GRAPHICAL_HIERARCHY    = YES
211DIRECTORY_GRAPH        = YES
212DOT_IMAGE_FORMAT       = gif
213DOT_PATH               =
214DOTFILE_DIRS           =
215MAX_DOT_GRAPH_WIDTH    = 1024
216MAX_DOT_GRAPH_HEIGHT   = 1024
217MAX_DOT_GRAPH_DEPTH    = 0
218DOT_TRANSPARENT        = NO
219DOT_MULTI_TARGETS      = NO
220GENERATE_LEGEND        = YES
221DOT_CLEANUP            = YES
222#---------------------------------------------------------------------------
223# Configuration::additions related to the search engine
224#---------------------------------------------------------------------------
225SEARCHENGINE           = NO
226