comparison doc/ALmixer.doxyfile.cmake @ 5:8cb13d89451a

Doxygen support and fixes.
author Eric Wing <ewing . public |-at-| gmail . com>
date Thu, 28 Oct 2010 01:26:11 -0700
parents
children
comparison
equal deleted inserted replaced
4:26aec5629f68 5:8cb13d89451a
1
2 #---------------------------------------------------------------------------
3 # Project related configuration options
4 #---------------------------------------------------------------------------
5 DOXYFILE_ENCODING = UTF-8
6 PROJECT_NAME = ALmixer
7 PROJECT_NUMBER = 1
8 OUTPUT_DIRECTORY = "@PROJECT_BINARY_DIR@/doc"
9 CREATE_SUBDIRS = NO
10 OUTPUT_LANGUAGE = English
11 BRIEF_MEMBER_DESC = YES
12 REPEAT_BRIEF = YES
13 ABBREVIATE_BRIEF = "The $name class" \
14 "The $name widget" \
15 "The $name file" \
16 is \
17 provides \
18 specifies \
19 contains \
20 represents \
21 a \
22 an \
23 the
24 ALWAYS_DETAILED_SEC = NO
25 INLINE_INHERITED_MEMB = NO
26 FULL_PATH_NAMES = NO
27 STRIP_FROM_PATH = /Applications/
28 STRIP_FROM_INC_PATH =
29 SHORT_NAMES = NO
30 JAVADOC_AUTOBRIEF = YES
31 QT_AUTOBRIEF = NO
32 MULTILINE_CPP_IS_BRIEF = NO
33 INHERIT_DOCS = YES
34 SEPARATE_MEMBER_PAGES = NO
35 TAB_SIZE = 8
36 ALIASES =
37 OPTIMIZE_OUTPUT_FOR_C = YES
38 OPTIMIZE_OUTPUT_JAVA = NO
39 OPTIMIZE_FOR_FORTRAN = NO
40 OPTIMIZE_OUTPUT_VHDL = NO
41 EXTENSION_MAPPING =
42 BUILTIN_STL_SUPPORT = NO
43 CPP_CLI_SUPPORT = NO
44 SIP_SUPPORT = NO
45 IDL_PROPERTY_SUPPORT = YES
46 DISTRIBUTE_GROUP_DOC = NO
47 SUBGROUPING = YES
48 TYPEDEF_HIDES_STRUCT = YES
49 SYMBOL_CACHE_SIZE = 0
50
51 #---------------------------------------------------------------------------
52 # Build related configuration options
53 #---------------------------------------------------------------------------
54 EXTRACT_ALL = YES
55 EXTRACT_PRIVATE = NO
56 EXTRACT_STATIC = NO
57 EXTRACT_LOCAL_CLASSES = YES
58 EXTRACT_LOCAL_METHODS = NO
59 EXTRACT_ANON_NSPACES = NO
60 HIDE_UNDOC_MEMBERS = NO
61 HIDE_UNDOC_CLASSES = NO
62 HIDE_FRIEND_COMPOUNDS = NO
63 HIDE_IN_BODY_DOCS = NO
64 INTERNAL_DOCS = NO
65 CASE_SENSE_NAMES = NO
66 HIDE_SCOPE_NAMES = NO
67 SHOW_INCLUDE_FILES = YES
68 FORCE_LOCAL_INCLUDES = NO
69 INLINE_INFO = YES
70 SORT_MEMBER_DOCS = YES
71 SORT_BRIEF_DOCS = NO
72 SORT_MEMBERS_CTORS_1ST = NO
73 SORT_GROUP_NAMES = NO
74 SORT_BY_SCOPE_NAME = NO
75 GENERATE_TODOLIST = YES
76 GENERATE_TESTLIST = YES
77 GENERATE_BUGLIST = YES
78 GENERATE_DEPRECATEDLIST= YES
79 ENABLED_SECTIONS =
80 MAX_INITIALIZER_LINES = 30
81 SHOW_USED_FILES = YES
82 SHOW_DIRECTORIES = NO
83 SHOW_FILES = YES
84 SHOW_NAMESPACES = YES
85 FILE_VERSION_FILTER =
86 LAYOUT_FILE =
87
88 #---------------------------------------------------------------------------
89 # configuration options related to warning and progress messages
90 #---------------------------------------------------------------------------
91 QUIET = NO
92 WARNINGS = YES
93 WARN_IF_UNDOCUMENTED = YES
94 WARN_IF_DOC_ERROR = YES
95 WARN_NO_PARAMDOC = NO
96 WARN_FORMAT = "$file:$line: $text"
97 WARN_LOGFILE =
98
99 #---------------------------------------------------------------------------
100 # configuration options related to the input files
101 #---------------------------------------------------------------------------
102 INPUT = "@PROJECT_SOURCE_DIR@"
103 INPUT_ENCODING = UTF-8
104 FILE_PATTERNS = *.c \
105 *.cc \
106 *.cxx \
107 *.cpp \
108 *.c++ \
109 *.java \
110 *.ii \
111 *.ixx \
112 *.ipp \
113 *.i++ \
114 *.inl \
115 *.h \
116 *.hh \
117 *.hxx \
118 *.hpp \
119 *.h++ \
120 *.idl \
121 *.odl \
122 *.cs \
123 *.php \
124 *.php3 \
125 *.inc \
126 *.m \
127 *.mm \
128 *.dox \
129 *.py \
130 *.f90 \
131 *.f \
132 *.vhd \
133 *.vhdl
134 RECURSIVE = NO
135 EXCLUDE =
136 EXCLUDE_SYMLINKS = NO
137 EXCLUDE_PATTERNS =
138 EXCLUDE_SYMBOLS =
139 EXAMPLE_PATH =
140 EXAMPLE_PATTERNS = *
141 EXAMPLE_RECURSIVE = NO
142 IMAGE_PATH =
143 INPUT_FILTER =
144 FILTER_PATTERNS =
145 FILTER_SOURCE_FILES = NO
146
147 #---------------------------------------------------------------------------
148 # configuration options related to source browsing
149 #---------------------------------------------------------------------------
150 SOURCE_BROWSER = NO
151 INLINE_SOURCES = NO
152 STRIP_CODE_COMMENTS = YES
153 REFERENCED_BY_RELATION = NO
154 REFERENCES_RELATION = NO
155 REFERENCES_LINK_SOURCE = YES
156 USE_HTAGS = NO
157 VERBATIM_HEADERS = YES
158
159 #---------------------------------------------------------------------------
160 # configuration options related to the alphabetical class index
161 #---------------------------------------------------------------------------
162 ALPHABETICAL_INDEX = NO
163 COLS_IN_ALPHA_INDEX = 5
164 IGNORE_PREFIX =
165
166 #---------------------------------------------------------------------------
167 # configuration options related to the HTML output
168 #---------------------------------------------------------------------------
169 GENERATE_HTML = YES
170 HTML_OUTPUT = html
171 HTML_FILE_EXTENSION = .html
172 HTML_HEADER =
173 HTML_FOOTER =
174 HTML_STYLESHEET =
175 HTML_COLORSTYLE_HUE = 220
176 HTML_COLORSTYLE_SAT = 100
177 HTML_COLORSTYLE_GAMMA = 80
178 HTML_TIMESTAMP = YES
179 HTML_ALIGN_MEMBERS = YES
180 HTML_DYNAMIC_SECTIONS = NO
181 GENERATE_DOCSET = NO
182 DOCSET_FEEDNAME = "Doxygen generated docs"
183 DOCSET_BUNDLE_ID = org.doxygen.Project
184 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
185 DOCSET_PUBLISHER_NAME = Publisher
186 GENERATE_HTMLHELP = NO
187 CHM_FILE =
188 HHC_LOCATION =
189 GENERATE_CHI = NO
190 CHM_INDEX_ENCODING =
191 BINARY_TOC = NO
192 TOC_EXPAND = NO
193 GENERATE_QHP = NO
194 QCH_FILE =
195 QHP_NAMESPACE = org.doxygen.Project
196 QHP_VIRTUAL_FOLDER = doc
197 QHP_CUST_FILTER_NAME =
198 QHP_CUST_FILTER_ATTRS =
199 QHP_SECT_FILTER_ATTRS =
200 QHG_LOCATION =
201 GENERATE_ECLIPSEHELP = NO
202 ECLIPSE_DOC_ID = org.doxygen.Project
203 DISABLE_INDEX = NO
204 ENUM_VALUES_PER_LINE = 4
205 GENERATE_TREEVIEW = NO
206 USE_INLINE_TREES = NO
207 TREEVIEW_WIDTH = 250
208 EXT_LINKS_IN_WINDOW = NO
209 FORMULA_FONTSIZE = 10
210 FORMULA_TRANSPARENT = YES
211 USE_MATHJAX = NO
212 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
213 SEARCHENGINE = YES
214 SERVER_BASED_SEARCH = NO
215
216 #---------------------------------------------------------------------------
217 # configuration options related to the LaTeX output
218 #---------------------------------------------------------------------------
219 GENERATE_LATEX = NO
220 LATEX_OUTPUT = latex
221 LATEX_CMD_NAME = latex
222 MAKEINDEX_CMD_NAME = makeindex
223 COMPACT_LATEX = NO
224 PAPER_TYPE = a4
225 EXTRA_PACKAGES =
226 LATEX_HEADER =
227 PDF_HYPERLINKS = YES
228 USE_PDFLATEX = YES
229 LATEX_BATCHMODE = NO
230 LATEX_HIDE_INDICES = NO
231 LATEX_SOURCE_CODE = NO
232
233 #---------------------------------------------------------------------------
234 # configuration options related to the RTF output
235 #---------------------------------------------------------------------------
236 GENERATE_RTF = NO
237 RTF_OUTPUT = rtf
238 COMPACT_RTF = NO
239 RTF_HYPERLINKS = NO
240 RTF_STYLESHEET_FILE =
241 RTF_EXTENSIONS_FILE =
242
243 #---------------------------------------------------------------------------
244 # configuration options related to the man page output
245 #---------------------------------------------------------------------------
246 GENERATE_MAN = NO
247 MAN_OUTPUT = man
248 MAN_EXTENSION = .3
249 MAN_LINKS = NO
250
251 #---------------------------------------------------------------------------
252 # configuration options related to the XML output
253 #---------------------------------------------------------------------------
254 GENERATE_XML = NO
255 XML_OUTPUT = xml
256 XML_SCHEMA =
257 XML_DTD =
258 XML_PROGRAMLISTING = YES
259
260 #---------------------------------------------------------------------------
261 # configuration options for the AutoGen Definitions output
262 #---------------------------------------------------------------------------
263 GENERATE_AUTOGEN_DEF = NO
264
265 #---------------------------------------------------------------------------
266 # configuration options related to the Perl module output
267 #---------------------------------------------------------------------------
268 GENERATE_PERLMOD = NO
269 PERLMOD_LATEX = NO
270 PERLMOD_PRETTY = YES
271 PERLMOD_MAKEVAR_PREFIX =
272
273 #---------------------------------------------------------------------------
274 # Configuration options related to the preprocessor
275 #---------------------------------------------------------------------------
276 ENABLE_PREPROCESSING = YES
277 MACRO_EXPANSION = YES
278 EXPAND_ONLY_PREDEF = YES
279 SEARCH_INCLUDES = YES
280 INCLUDE_PATH =
281 INCLUDE_FILE_PATTERNS =
282 PREDEFINED = DOXYGEN_ONLY \
283 DOXYGEN_SHOULD_IGNORE_THIS \
284 ALMIXER_DECLSPEC= \
285 ALMIXER_CALL=
286 EXPAND_AS_DEFINED =
287 SKIP_FUNCTION_MACROS = YES
288
289 #---------------------------------------------------------------------------
290 # Configuration::additions related to external references
291 #---------------------------------------------------------------------------
292 TAGFILES =
293 GENERATE_TAGFILE =
294 ALLEXTERNALS = NO
295 EXTERNAL_GROUPS = YES
296 PERL_PATH = /usr/bin/perl
297
298 #---------------------------------------------------------------------------
299 # Configuration options related to the dot tool
300 #---------------------------------------------------------------------------
301 CLASS_DIAGRAMS = YES
302 MSCGEN_PATH =
303 HIDE_UNDOC_RELATIONS = YES
304 HAVE_DOT = @HAVE_DOT@
305 #HAVE_DOT = NO
306 DOT_NUM_THREADS = 0
307 DOT_FONTNAME = FreeSans.ttf
308 DOT_FONTSIZE = 10
309 DOT_FONTPATH =
310 CLASS_GRAPH = YES
311 COLLABORATION_GRAPH = YES
312 GROUP_GRAPHS = YES
313 UML_LOOK = NO
314 TEMPLATE_RELATIONS = NO
315 INCLUDE_GRAPH = YES
316 INCLUDED_BY_GRAPH = YES
317 CALL_GRAPH = NO
318 CALLER_GRAPH = NO
319 GRAPHICAL_HIERARCHY = YES
320 DIRECTORY_GRAPH = YES
321 DOT_IMAGE_FORMAT = png
322 DOT_PATH = @DOT_PATH@
323 DOTFILE_DIRS =
324 MSCFILE_DIRS =
325 DOT_GRAPH_MAX_NODES = 50
326 MAX_DOT_GRAPH_DEPTH = 0
327 DOT_TRANSPARENT = NO
328 DOT_MULTI_TARGETS = NO
329 GENERATE_LEGEND = YES
330 DOT_CLEANUP = YES
331