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