1 /**
2 * The Doxygen Maven Plugin (dmp)
3 *
4 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 by SoftwareEntwicklung Beratung Schulung (SoEBeS)
5 * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 by Karl Heinz Marbaise
6 *
7 * Licensed to the Apache Software Foundation (ASF) under one or more
8 * contributor license agreements. See the NOTICE file distributed with
9 * this work for additional information regarding copyright ownership.
10 * The ASF licenses this file to You under the Apache License, Version 2.0
11 * (the "License"); you may not use this file except in compliance with
12 * the License. You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 */
22 package com.soebes.maven.plugins.doxygen;
23
24 import java.io.File;
25
26 import org.apache.maven.plugin.AbstractMojo;
27 import org.apache.maven.plugins.annotations.Parameter;
28
29 /**
30 * This class contains all configurable parameters for the doxygen call. These
31 * parameters can be defined in the configuration section of the plugin in.
32 *
33 * @author Karl Heinz Marbaise
34 *
35 */
36 public abstract class AbstractDoxygenConfigurationMojo extends AbstractMojo {
37
38 /**
39 * This defines which file will be used as Doxygen configuration file
40 * instead of creating one.
41 *
42 */
43 @Parameter(property = "doxygen.configurationFile")
44 private File configurationFile;
45
46 /**
47 * This tag specifies the encoding used for all characters in the config
48 * file that follow. The default is UTF-8 which is also the encoding used
49 * for all text before the first occurrence of this tag. Doxygen uses
50 * libiconv (or the iconv built into libc) for the transcoding. See
51 * http://www.gnu.org/software/libiconv for the list of possible encodings.
52 *
53 */
54 @Parameter(property="doxygen.doxyfileEncoding", defaultValue="UTF-8")
55 private String doxyfileEncoding;
56
57 /**
58 * The PROJECT_NAME tag is a single word (or a sequence of words surrounded
59 * by quotes) that should identify the project.
60 *
61 */
62 @Parameter(property="doxygen.projectName", defaultValue="${project.name}")
63 private String projectName;
64
65 /**
66 * The PROJECT_NUMBER tag can be used to enter a project or revision number.
67 * This could be handy for archiving the generated documentation or if some
68 * version control system is used.
69 *
70 * @Parameter(property="doxygen.projectNumber")
71 */
72 @Parameter(property = "doxygen.projectNumber")
73 private String projectNumber;
74
75 /**
76 * If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096
77 * sub-directories (in 2 levels) under the output directory of each output
78 * format and will distribute the generated files over these directories.
79 * Enabling this option can be useful when feeding doxygen a huge amount of
80 * source files, where putting all generated files in the same directory
81 * would otherwise cause performance problems for the file system.
82 *
83 */
84 @Parameter(property="doxygen.createSubdirs", defaultValue="false")
85 private boolean createSubdirs;
86
87 /**
88 * The OUTPUT_LANGUAGE tag is used to specify the language in which all
89 * documentation generated by doxygen is written. Doxygen will use this
90 * information to generate all constant output in the proper language. The
91 * default language is English, other supported languages are: Afrikaans,
92 * Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian,
93 * Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, Hungarian,
94 * Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
95 * Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
96 * Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
97 * Spanish, Swedish, and Ukrainian.
98 *
99 */
100 @Parameter(property="doxygen.outputLanguage", defaultValue="English")
101 private String outputLanguage;
102
103 /**
104 * If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
105 * include brief member descriptions after the members that are listed in
106 * the file and class documentation (similar to JavaDoc). Set to NO to
107 * disable this.
108 *
109 */
110 @Parameter(property="doxygen.briefMemberDesc", defaultValue="true")
111 private boolean briefMemberDesc;
112
113 /**
114 * If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
115 * the brief description of a member or function before the detailed
116 * description. Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are
117 * set to NO, the brief descriptions will be completely suppressed.
118 *
119 */
120 @Parameter(property="doxygen.repeatBrief", defaultValue="true")
121 private boolean repeatBrief;
122
123 /**
124 * This tag implements a quasi-intelligent brief description abbreviator
125 * that is used to form the text in various listings. Each string in this
126 * list, if found as the leading text of the brief description, will be
127 * stripped from the text and the result after processing the whole list, is
128 * used as the annotated text. Otherwise, the brief description is used
129 * as-is. If left blank, the following values are used ("$name" is
130 * automatically replaced with the name of the entity): "The $name class"
131 * "The $name widget" "The $name file" "is" "provides" "specifies"
132 * "contains" "represents" "a" "an" "the"
133 *
134 */
135 @Parameter(property="doxygen.abbreviateBrief")
136 private String abbreviateBrief;
137
138 /**
139 * If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
140 * Doxygen will generate a detailed section even if there is only a brief
141 * description.
142 *
143 */
144 @Parameter(property="doxygen.alwaysDetailedSec", defaultValue="false")
145 private boolean alwaysDetailedSec;
146
147 /**
148 * If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149 * inherited members of a class in the documentation of that class as if
150 * those members were ordinary class members. Constructors, destructors and
151 * assignment operators of the base classes will not be shown.
152 *
153 */
154 @Parameter(property="doxygen.inlineInheritedMemb", defaultValue="false")
155 private boolean inlineInheritedMemb;
156
157 /**
158 * If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the
159 * full path before files name in the file list and in the header files. If
160 * set to NO the shortest path that makes the file name unique will be used.
161 *
162 */
163 @Parameter(property="doxygen.fullPathNames", defaultValue="true")
164 private boolean fullPathNames;
165
166 /**
167 * If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag can
168 * be used to strip a user-defined part of the path. Stripping is only done
169 * if one of the specified strings matches the left-hand part of the path.
170 * The tag can be used to show relative paths in the file list. If left
171 * blank the directory from which doxygen is run is used as the path to
172 * strip.
173 *
174 */
175 @Parameter(property="doxygen.stripFromPath")
176 private String stripFromPath;
177
178 /**
179 * The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
180 * the path mentioned in the documentation of a class, which tells the
181 * reader which header file to include in order to use a class. If left
182 * blank only the name of the header file containing the class definition is
183 * used. Otherwise one should specify the include paths that are normally
184 * passed to the compiler using the -I flag.
185 *
186 */
187 @Parameter(property="doxygen.stripFromIncPath")
188 private String stripFromIncPath;
189
190 /**
191 * If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
192 * (but less readable) file names. This can be useful is your file systems
193 * doesn't support long names like on DOS, Mac, or CD-ROM.
194 *
195 */
196 @Parameter(property="doxygen.shortNames", defaultValue="false")
197 private boolean shortNames;
198
199 /**
200 * If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret
201 * the first line (until the first dot) of a JavaDoc-style comment as the
202 * brief description. If set to NO, the JavaDoc comments will behave just
203 * like regular Qt-style comments (thus requiring an explicit @brief command
204 * for a brief description.)
205 *
206 */
207 @Parameter(property="doxygen.javadocAutobrief", defaultValue="false")
208 private boolean javadocAutobrief;
209
210 /**
211 * If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the
212 * first line (until the first dot) of a Qt-style comment as the brief
213 * description. If set to NO, the comments will behave just like regular
214 * Qt-style comments (thus requiring an explicit \brief command for a brief
215 * description.)
216 *
217 */
218 @Parameter(property="doxygen.qtAutobrief", defaultValue="false")
219 private boolean qtAutobrief;
220
221 /**
222 * The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
223 * multi-line C++ special comment block (i.e. a block of //! or ///
224 * comments) as a brief description. This used to be the default behaviour.
225 * The new default is to treat a multi-line C++ comment block as a detailed
226 * description. Set this tag to YES if you prefer the old behaviour instead.
227 *
228 */
229 @Parameter(property="doxygen.multilineCppIsBrief", defaultValue="false")
230 private boolean multilineCppIsBrief;
231
232 /**
233 * If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
234 * member inherits the documentation from any documented member that it
235 * re-implements.
236 *
237 */
238 @Parameter(property="doxygen.inheritDocs", defaultValue="true")
239 private boolean inheritDocs;
240
241 /**
242 * If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
243 * a new page for each member. If set to NO, the documentation of a member
244 * will be part of the file/class/namespace that contains it.
245 *
246 */
247 @Parameter(property="doxygen.separateMemberPages", defaultValue="false")
248 private boolean separateMemberPages;
249
250 /**
251 * The TAB_SIZE tag can be used to set the number of spaces in a tab.
252 * Doxygen uses this value to replace tabs by spaces in code fragments.
253 *
254 */
255 @Parameter(property="doxygen.tabSize", defaultValue="8")
256 private Integer tabSize;
257
258 /**
259 * This tag can be used to specify a number of aliases that acts as commands
260 * in the documentation. An alias has the form "name=value". For example
261 * adding "sideeffect=\par Side Effects:\n" will allow you to put the
262 * command \sideeffect (or @sideeffect) in the documentation, which will
263 * result in a user-defined paragraph with heading "Side Effects:". You can
264 * put \n's in the value part of an alias to insert newlines.
265 *
266 */
267 @Parameter(property="doxygen.aliases")
268 private String aliases;
269
270 /**
271 * Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
272 * sources only. Doxygen will then generate output that is more tailored for
273 * C. For instance, some of the names that are used will be different. The
274 * list of all members will be omitted, etc.
275 *
276 */
277 @Parameter(property="doxygen.optimizeOutputForC", defaultValue="false")
278 private boolean optimizeOutputForC;
279
280 /**
281 * Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
282 * sources only. Doxygen will then generate output that is more tailored for
283 * Java. For instance, namespaces will be presented as packages, qualified
284 * scopes will look different, etc.
285 *
286 */
287 @Parameter(property="doxygen.optimizeOutputJava", defaultValue="false")
288 private boolean optimizeOutputJava;
289
290 /**
291 * Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of
292 * Fortran sources only. Doxygen will then generate output that is more
293 * tailored for Fortran.
294 *
295 */
296 @Parameter(property="doxygen.optimizeForFortran", defaultValue="false")
297 private boolean optimizeForFortran;
298
299 /**
300 * Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
301 * sources. Doxygen will then generate output that is tailored for VHDL.
302 *
303 */
304 @Parameter(property="doxygen.optimizeOutputVhdl", defaultValue="false")
305 private boolean optimizeOutputVhdl;
306
307 /**
308 * If you use STL classes (i.e. std::string, std::vector, etc.) but do not
309 * want to include (a tag file for) the STL sources as input, then you
310 * should set this tag to YES in order to let doxygen match functions
311 * declarations and definitions whose arguments contain STL classes (e.g.
312 * func(std::string); v.s. func(std::string) {}). This also make the
313 * inheritance and collaboration diagrams that involve STL classes more
314 * complete and accurate.
315 *
316 */
317 @Parameter(property="doxygen.builtinStlSupport", defaultValue="true")
318 private boolean builtinStlSupport;
319
320 /**
321 * If you use Microsoft's C++/CLI language, you should set this option to
322 * YES to enable parsing support.
323 *
324 */
325 @Parameter(property="doxygen.cppCliSupport", defaultValue="false")
326 private boolean cppCliSupport;
327
328 /**
329 * Set the SIP_SUPPORT tag to YES if your project consists of sip sources
330 * only. Doxygen will parse them like normal C++ but will assume all classes
331 * use public instead of private inheritance when no explicit protection
332 * keyword is present.
333 *
334 */
335 @Parameter(property="doxygen.sipSupport", defaultValue="false")
336 private boolean sipSupport;
337
338 /**
339 * For Microsoft's IDL there are propget and propput attributes to indicate
340 * getter and setter methods for a property. Setting this option to YES (the
341 * default) will make doxygen to replace the get and set methods by a
342 * property in the documentation. This will only work if the methods are
343 * indeed getting or setting a simple type. If this is not the case, or you
344 * want to show the methods anyway, you should set this option to NO.
345 *
346 */
347 @Parameter(property="doxygen.idlPropertySupport", defaultValue="true")
348 private boolean idlPropertySupport;
349
350 /**
351 * If member grouping is used in the documentation and the
352 * DISTRIBUTE_GROUP_DOC tag is set to YES, then doxygen will reuse the
353 * documentation of the first member in the group (if any) for the other
354 * members of the group. By default all members of a group must be
355 * documented explicitly.
356 *
357 */
358 @Parameter(property="doxygen.distributeGroupDoc", defaultValue="false")
359 private boolean distributeGroupDoc;
360
361 /**
362 * Set the SUBGROUPING tag to YES (the default) to allow class member groups
363 * of the same type (for instance a group of public functions) to be put as
364 * a subgroup of that type (e.g. under the Public Functions section). Set it
365 * to NO to prevent subgrouping. Alternatively, this can be done per class
366 * using the \nosubgrouping command.
367 *
368 */
369 @Parameter(property="doxygen.subgrouping", defaultValue="true")
370 private boolean subgrouping;
371
372 /**
373 * When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or
374 * enum is documented as struct, union, or enum with the name of the
375 * typedef. So typedef struct TypeS {} TypeT, will appear in the
376 * documentation as a struct with name TypeT. When disabled the typedef will
377 * appear as a member of a file, namespace, or class. And the struct will be
378 * named TypeS. This can typically be useful for C code in case the coding
379 * convention dictates that all compound types are typedef'ed and only the
380 * typedef is referenced, never the tag name.
381 *
382 */
383 @Parameter(property="doxygen.typedefHidesStruct", defaultValue="false")
384 private boolean typedefHidesStruct;
385
386 /**
387 * The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
388 * determine which symbols to keep in memory and which to flush to disk.
389 * When the cache is full, less often used symbols will be written to disk.
390 * For small to medium size projects (<1000 input files) the default
391 * value is probably good enough. For larger projects a too small cache size
392 * can cause doxygen to be busy swapping symbols to and from disk most of
393 * the time causing a significant performance penality. If the system has
394 * enough physical memory increasing the cache will improve the performance
395 * by keeping more symbols in memory. Note that the value works on a
396 * logarithmic scale so increasing the size by one will rougly double the
397 * memory usage. The cache size is given by this formula:
398 * 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
399 * corresponding to a cache size of 2^16 = 65536 symbols
400 *
401 */
402 @Parameter(property="doxygen.symbolCacheSize", defaultValue="0")
403 private Integer symbolCacheSize;
404
405 /**
406 * If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
407 * documentation are documented, even if no documentation was available.
408 * Private class members and static file members will be hidden unless the
409 * EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
410 *
411 */
412 @Parameter(property="doxygen.extractAll", defaultValue="false")
413 private boolean extractAll;
414
415 /**
416 * If the EXTRACT_PRIVATE tag is set to YES all private members of a class
417 * will be included in the documentation.
418 *
419 */
420 @Parameter(property="doxygen.extractPrivate", defaultValue="false")
421 private boolean extractPrivate;
422
423 /**
424 * If the EXTRACT_STATIC tag is set to YES all static members of a file will
425 * be included in the documentation.
426 *
427 */
428 @Parameter(property="doxygen.extractStatic", defaultValue="false")
429 private boolean extractStatic;
430
431 /**
432 * If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
433 * defined locally in source files will be included in the documentation. If
434 * set to NO only classes defined in header files are included.
435 *
436 */
437 @Parameter(property="doxygen.extractLocalClasses", defaultValue="true")
438 private boolean extractLocalClasses;
439
440 /**
441 * This flag is only useful for Objective-C code. When set to YES local
442 * methods, which are defined in the implementation section but not in the
443 * interface are included in the documentation. If set to NO (the default)
444 * only methods in the interface are included.
445 *
446 */
447 @Parameter(property="doxygen.extractLocalMethods", defaultValue="false")
448 private boolean extractLocalMethods;
449
450 /**
451 * If this flag is set to YES, the members of anonymous namespaces will be
452 * extracted and appear in the documentation as a namespace called
453 * 'anonymous_namespace{file}', where file will be replaced with the base
454 * name of the file that contains the anonymous namespace. By default
455 * anonymous namespace are hidden.
456 *
457 */
458 @Parameter(property="doxygen.extractAnonNspaces", defaultValue="false")
459 private boolean extractAnonNspaces;
460
461 /**
462 * If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
463 * undocumented members of documented classes, files or namespaces. If set
464 * to NO (the default) these members will be included in the various
465 * overviews, but no documentation section is generated. This option has no
466 * effect if EXTRACT_ALL is enabled.
467 *
468 */
469 @Parameter(property="doxygen.hideUndocMembers", defaultValue="false")
470 private boolean hideUndocMembers;
471
472 /**
473 * If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
474 * undocumented classes that are normally visible in the class hierarchy. If
475 * set to NO (the default) these classes will be included in the various
476 * overviews. This option has no effect if EXTRACT_ALL is enabled.
477 *
478 */
479 @Parameter(property="doxygen.hideUndocClasses", defaultValue="false")
480 private boolean hideUndocClasses;
481
482 /**
483 * If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
484 * friend (class|struct|union) declarations. If set to NO (the default)
485 * these declarations will be included in the documentation.
486 *
487 */
488 @Parameter(property="doxygen.hideFriendCompounds", defaultValue="false")
489 private boolean hideFriendCompounds;
490
491 /**
492 * If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
493 * documentation blocks found inside the body of a function. If set to NO
494 * (the default) these blocks will be appended to the function's detailed
495 * documentation block.
496 *
497 */
498 @Parameter(property="doxygen.hideInBodyDocs", defaultValue="false")
499 private boolean hideInBodyDocs;
500
501 /**
502 * The INTERNAL_DOCS tag determines if documentation that is typed after a
503 * \internal command is included. If the tag is set to NO (the default) then
504 * the documentation will be excluded. Set it to YES to include the internal
505 * documentation.
506 *
507 */
508 @Parameter(property="doxygen.internalDocs", defaultValue="false")
509 private boolean internalDocs;
510
511 /**
512 * If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
513 * file names in lower-case letters. If set to YES upper-case letters are
514 * also allowed. This is useful if you have classes or files whose names
515 * only differ in case and if your file system supports case sensitive file
516 * names. Windows and Mac users are advised to set this option to NO.
517 *
518 */
519 @Parameter(property="doxygen.caseSenseNames", defaultValue="true")
520 private boolean caseSenseNames;
521
522 /**
523 * If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen will
524 * show members with their full class and namespace scopes in the
525 * documentation. If set to YES the scope will be hidden.
526 *
527 */
528 @Parameter(property="doxygen.hideScopeNames", defaultValue="false")
529 private boolean hideScopeNames;
530
531 /**
532 * If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
533 * will put a list of the files that are included by a file in the
534 * documentation of that file.
535 *
536 */
537 @Parameter(property="doxygen.showIncludeFiles", defaultValue="true")
538 private boolean showIncludeFiles;
539
540 /**
541 * If the INLINE_INFO tag is set to YES (the default) then a tag [inline] is
542 * inserted in the documentation for inline members.
543 *
544 */
545 @Parameter(property="doxygen.inlineInfo", defaultValue="true")
546 private boolean inlineInfo;
547
548 /**
549 * If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen will
550 * sort the (detailed) documentation of file and class members
551 * alphabetically by member name. If set to NO the members will appear in
552 * declaration order.
553 *
554 */
555 @Parameter(property="doxygen.sortMemberDocs", defaultValue="true")
556 private boolean sortMemberDocs;
557
558 /**
559 * If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
560 * documentation of file, namespace and class members alphabetically by
561 * member name. If set to NO (the default) the members will appear in
562 * declaration order.
563 *
564 */
565 @Parameter(property="doxygen.sortBriefDocs", defaultValue="false")
566 private boolean sortBriefDocs;
567
568 /**
569 * If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
570 * hierarchy of group names into alphabetical order. If set to NO (the
571 * default) the group names will appear in their defined order.
572 *
573 */
574 @Parameter(property="doxygen.sortGroupNames", defaultValue="false")
575 private boolean sortGroupNames;
576
577 /**
578 * If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
579 * sorted by fully-qualified names, including namespaces. If set to NO (the
580 * default), the class list will be sorted only by class name, not including
581 * the namespace part. Note: This option is not very useful if
582 * HIDE_SCOPE_NAMES is set to YES. Note: This option applies only to the
583 * class list, not to the alphabetical list.
584 *
585 */
586 @Parameter(property="doxygen.sortByScopeName", defaultValue="false")
587 private boolean sortByScopeName;
588
589 /**
590 * The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the
591 * todo list. This list is created by putting \todo commands in the
592 * documentation.
593 *
594 */
595 @Parameter(property="doxygen.generateTodolist", defaultValue="true")
596 private boolean generateTodolist;
597
598 /**
599 * The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the
600 * test list. This list is created by putting \test commands in the
601 * documentation.
602 *
603 */
604 @Parameter(property="doxygen.generateTestlist", defaultValue="true")
605 private boolean generateTestlist;
606
607 /**
608 * The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the
609 * bug list. This list is created by putting \bug commands in the
610 * documentation.
611 *
612 */
613 @Parameter(property="doxygen.generateBuglist", defaultValue="true")
614 private boolean generateBuglist;
615
616 /**
617 * The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable
618 * (NO) the deprecated list. This list is created by putting \deprecated
619 * commands in the documentation.
620 *
621 */
622 @Parameter(property="doxygen.generateDeprecatedlist", defaultValue="true")
623 private boolean generateDeprecatedlist;
624
625 /**
626 * The ENABLED_SECTIONS tag can be used to enable conditional documentation
627 * sections, marked by \if sectionname ... \endif.
628 *
629 */
630 @Parameter(property="doxygen.enabledSections")
631 private String enabledSections;
632
633 /**
634 * The MAX_INITIALIZER_LINES tag determines the maximum number of lines the
635 * initial value of a variable or define consists of for it to appear in the
636 * documentation. If the initializer consists of more lines than specified
637 * here it will be hidden. Use a value of 0 to hide initializers completely.
638 * The appearance of the initializer of individual variables and defines in
639 * the documentation can be controlled using \showinitializer or
640 * \hideinitializer command in the documentation regardless of this setting.
641 *
642 */
643 @Parameter(property="doxygen.maxInitializerLines", defaultValue="30")
644 private Integer maxInitializerLines;
645
646 /**
647 * Set the SHOW_USED_FILES tag to NO to disable the list of files generated
648 * at the bottom of the documentation of classes and structs. If set to YES
649 * the list will mention the files that were used to generate the
650 * documentation.
651 *
652 */
653 @Parameter(property="doxygen.showUsedFiles", defaultValue="true")
654 private boolean showUsedFiles;
655
656 /**
657 * If the sources in your project are distributed over multiple directories
658 * then setting the SHOW_DIRECTORIES tag to YES will show the directory
659 * hierarchy in the documentation. The default is NO.
660 *
661 */
662 @Parameter(property="doxygen.showDirectories", defaultValue="true")
663 private boolean showDirectories;
664
665 /**
666 * Set the SHOW_FILES tag to NO to disable the generation of the Files page.
667 * This will remove the Files entry from the Quick Index and from the Folder
668 * Tree View (if specified). The default is YES.
669 *
670 */
671 @Parameter(property="doxygen.showFiles", defaultValue="true")
672 private boolean showFiles;
673
674 /**
675 * Set the SHOW_NAMESPACES tag to NO to disable the generation of the
676 * Namespaces page. This will remove the Namespaces entry from the Quick
677 * Index and from the Folder Tree View (if specified). The default is YES.
678 *
679 */
680 @Parameter(property="doxygen.showNamespaces", defaultValue="true")
681 private boolean showNamespaces;
682
683 /**
684 * The FILE_VERSION_FILTER tag can be used to specify a program or script
685 * that doxygen should invoke to get the current version for each file
686 * (typically from the version control system). Doxygen will invoke the
687 * program by executing (via popen()) the command <command>
688 * <input-file>, where <command> is the value of the
689 * FILE_VERSION_FILTER tag, and <input-file> is the name of an input
690 * file provided by doxygen. Whatever the program writes to standard output
691 * is used as the file version. See the manual for examples.
692 *
693 */
694 @Parameter(property="doxygen.fileVersionFilter")
695 private String fileVersionFilter;
696
697 /**
698 * The LAYOUT_FILE tag can be used to specify a layout file which will be
699 * parsed by doxygen. The layout file controls the global structure of the
700 * generated output files in an output format independent way. The create
701 * the layout file that represents doxygen's defaults, run doxygen with the
702 * -l option. You can optionally specify a file name after the option, if
703 * omitted DoxygenLayout.xml will be used as the name of the layout file.
704 *
705 */
706 @Parameter(property="doxygen.layoutFile")
707 private String layoutFile;
708
709 /**
710 * The QUIET tag can be used to turn on/off the messages that are generated
711 * by doxygen. Possible values are YES and NO. If left blank NO is used.
712 *
713 */
714 @Parameter(property="doxygen.quiet", defaultValue="true")
715 private boolean quiet;
716
717 /**
718 * The WARNINGS tag can be used to turn on/off the warning messages that are
719 * generated by doxygen. Possible values are YES and NO. If left blank NO is
720 * used.
721 *
722 */
723 @Parameter(property="doxygen.warnings", defaultValue="true")
724 private boolean warnings;
725
726 /**
727 * If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate
728 * warnings for undocumented members. If EXTRACT_ALL is set to YES then this
729 * flag will automatically be disabled.
730 *
731 */
732 @Parameter(property="doxygen.warnIfUndocumented", defaultValue="true")
733 private boolean warnIfUndocumented;
734
735 /**
736 * If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
737 * potential errors in the documentation, such as not documenting some
738 * parameters in a documented function, or documenting parameters that don't
739 * exist or using markup commands wrongly.
740 *
741 */
742 @Parameter(property="doxygen.warnIfDocError", defaultValue="true")
743 private boolean warnIfDocError;
744
745 /**
746 * This WARN_NO_PARAMDOC option can be abled to get warnings for functions
747 * that are documented, but have no documentation for their parameters or
748 * return value. If set to NO (the default) doxygen will only warn about
749 * wrong or incomplete parameter documentation, but not about the absence of
750 * documentation.
751 *
752 */
753 @Parameter(property="doxygen.warnNoParamdoc", defaultValue="true")
754 private boolean warnNoParamdoc;
755
756 /**
757 * The WARN_FORMAT tag determines the format of the warning messages that
758 * doxygen can produce. The string should contain the $file, $line, and
759 * $text tags, which will be replaced by the file and line number from which
760 * the warning originated and the warning text. Optionally the format may
761 * contain $version, which will be replaced by the version of the file (if
762 * it could be obtained via FILE_VERSION_FILTER)
763 *
764 */
765 @Parameter(property="doxygen.warnFormat", defaultValue="\"$file:$line: $text\"")
766 private String warnFormat;
767
768 /**
769 * The WARN_LOGFILE tag can be used to specify a file to which warning and
770 * error messages should be written. If left blank the output is written to
771 * stderr.
772 *
773 */
774 @Parameter(property="doxygen.warnLogfile")
775 private String warnLogfile;
776
777 /**
778 * The INPUT tag can be used to specify the files and/or directories that
779 * contain documented source files. You may enter file names like
780 * "myfile.cpp" or directories like "/usr/src/myproject". Separate the files
781 * or directories with spaces.
782 *
783 */
784 @Parameter(property="doxygen.input", defaultValue="${project.build.sourceDirectory}")
785 private String input;
786
787 /**
788 * This tag can be used to specify the character encoding of the source
789 * files that doxygen parses. Internally doxygen uses the UTF-8 encoding,
790 * which is also the default input encoding. Doxygen uses libiconv (or the
791 * iconv built into libc) for the transcoding. See
792 * http://www.gnu.org/software/libiconv for the list of possible encodings.
793 *
794 */
795 @Parameter(property="doxygen.inputEncoding", defaultValue="UTF-8")
796 private String inputEncoding;
797
798 /**
799 * If the value of the INPUT tag contains directories, you can use the
800 * FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
801 * *.h) to filter out the source-files in the directories. If left blank the
802 * following patterns are tested: *.c *.cc *.cxx *.cpp *.c++ *.java *.ii
803 * *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php
804 * *.php3 *.inc *.m *.mm *.py *.f90
805 *
806 */
807 @Parameter(property="doxygen.filePatterns", defaultValue="*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90")
808 private String filePatterns;
809
810 /**
811 * The RECURSIVE tag can be used to turn specify whether or not
812 * subdirectories should be searched for input files as well. Possible
813 * values are YES and NO. If left blank NO is used.
814 *
815 */
816 @Parameter(property="doxygen.recursive", defaultValue="false")
817 private boolean recursive;
818
819 /**
820 * The EXCLUDE tag can be used to specify files and/or directories that
821 * should excluded from the INPUT source files. This way you can easily
822 * exclude a subdirectory from a directory tree whose root is specified with
823 * the INPUT tag.
824 *
825 */
826 @Parameter(property="doxygen.exclude", defaultValue=".svn")
827 private String exclude;
828
829 /**
830 * The EXCLUDE_SYMLINKS tag can be used select whether or not files or
831 * directories that are symbolic links (a Unix filesystem feature) are
832 * excluded from the input.
833 *
834 */
835 @Parameter(property="doxygen.excludeSymlinks", defaultValue="false")
836 private boolean excludeSymlinks;
837
838 /**
839 * If the value of the INPUT tag contains directories, you can use the
840 * EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
841 * certain files from those directories. Note that the wildcards are matched
842 * against the file with absolute path, so to exclude all test directories
843 * for example use the pattern &x2a/test/&x2a
844 *
845 */
846 @Parameter(property="doxygen.excludePatterns")
847 private String excludePatterns;
848
849 /**
850 * The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
851 * (namespaces, classes, functions, etc.) that should be excluded from the
852 * output. The symbol name can be a fully qualified name, a word, or if the
853 * wildcard * is used, a substring. Examples: ANamespace, AClass,
854 * AClass::ANamespace, ANamespace::*Test
855 *
856 */
857 @Parameter(property="doxygen.excludeSymbols")
858 private String excludeSymbols;
859
860 /**
861 * The EXAMPLE_PATH tag can be used to specify one or more files or
862 * directories that contain example code fragments that are included (see
863 * the \include command).
864 *
865 */
866 @Parameter(property="doxygen.examplePath")
867 private String examplePath;
868
869 /**
870 * If the value of the EXAMPLE_PATH tag contains directories, you can use
871 * the EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like
872 * *.cpp and *.h) to filter out the source-files in the directories. If left
873 * blank all files are included.
874 *
875 */
876 @Parameter(property="doxygen.examplePatterns")
877 private String examplePatterns;
878
879 /**
880 * If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
881 * searched for input files to be used with the \include or \dontinclude
882 * commands irrespective of the value of the RECURSIVE tag. Possible values
883 * are YES and NO. If left blank NO is used.
884 *
885 */
886 @Parameter(property="doxygen.exampleRecursive", defaultValue="false")
887 private boolean exampleRecursive;
888
889 /**
890 * The IMAGE_PATH tag can be used to specify one or more files or
891 * directories that contain image that are included in the documentation
892 * (see the \image command).
893 *
894 */
895 @Parameter(property="doxygen.imagePath")
896 private String imagePath;
897
898 /**
899 * The INPUT_FILTER tag can be used to specify a program that doxygen should
900 * invoke to filter for each input file. Doxygen will invoke the filter
901 * program by executing (via popen()) the command <filter>
902 * <input-file>, where <filter> is the value of the INPUT_FILTER
903 * tag, and <input-file> is the name of an input file. Doxygen will
904 * then use the output that the filter program writes to standard output. If
905 * FILTER_PATTERNS is specified, this tag will be ignored.
906 *
907 */
908 @Parameter(property="doxygen.inputFilter")
909 private String inputFilter;
910
911 /**
912 * The FILTER_PATTERNS tag can be used to specify filters on a per file
913 * pattern basis. Doxygen will compare the file name with each pattern and
914 * apply the filter if there is a match. The filters are a list of the form:
915 * pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
916 * info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
917 * is applied to all files.
918 *
919 */
920 @Parameter(property="doxygen.filterPatterns")
921 private String filterPatterns;
922
923 /**
924 * If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set
925 * using INPUT_FILTER) will be used to filter the input files when producing
926 * source files to browse (i.e. when SOURCE_BROWSER is set to YES).
927 *
928 */
929 @Parameter(property="doxygen.filterSourceFiles", defaultValue="false")
930 private boolean filterSourceFiles;
931
932 /**
933 * If the SOURCE_BROWSER tag is set to YES then a list of source files will
934 * be generated. Documented entities will be cross-referenced with these
935 * sources. Note: To get rid of all source code in the generated output,
936 * make sure also VERBATIM_HEADERS is set to NO.
937 *
938 */
939 @Parameter(property="doxygen.sourceBrowser", defaultValue="true")
940 private boolean sourceBrowser;
941
942 /**
943 * Setting the INLINE_SOURCES tag to YES will include the body of functions
944 * and classes directly in the documentation.
945 *
946 */
947 @Parameter(property="doxygen.inlineSources", defaultValue="false")
948 private boolean inlineSources;
949
950 /**
951 * Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
952 * doxygen to hide any special comment blocks from generated source code
953 * fragments. Normal C and C++ comments will always remain visible.
954 *
955 */
956 @Parameter(property="doxygen.stripCodeComments", defaultValue="true")
957 private boolean stripCodeComments;
958
959 /**
960 * If the REFERENCED_BY_RELATION tag is set to YES then for each documented
961 * function all documented functions referencing it will be listed.
962 *
963 */
964 @Parameter(property="doxygen.referencedByRelation", defaultValue="false")
965 private boolean referencedByRelation;
966
967 /**
968 * If the REFERENCES_RELATION tag is set to YES then for each documented
969 * function all documented entities called/used by that function will be
970 * listed.
971 *
972 */
973 @Parameter(property="doxygen.referencesRelation", defaultValue="false")
974 private boolean referencesRelation;
975
976 /**
977 * If the REFERENCES_LINK_SOURCE tag is set to YES (the default) and
978 * SOURCE_BROWSER tag is set to YES, then the hyperlinks from functions in
979 * REFERENCES_RELATION and REFERENCED_BY_RELATION lists will link to the
980 * source code. Otherwise they will link to the documentstion.
981 *
982 */
983 @Parameter(property="doxygen.referencesLinkSource", defaultValue="true")
984 private boolean referencesLinkSource;
985
986 /**
987 * If the USE_HTAGS tag is set to YES then the references to source code
988 * will point to the HTML generated by the htags(1) tool instead of doxygen
989 * built-in source browser. The htags tool is part of GNU's global source
990 * tagging system (see http://www.gnu.org/software/global/global.html). You
991 * will need version 4.8.6 or higher.
992 *
993 */
994 @Parameter(property="doxygen.useHtags", defaultValue="false")
995 private boolean useHtags;
996
997 /**
998 * If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen will
999 * generate a verbatim copy of the header file for each class for which an
1000 * include is specified. Set to NO to disable this.
1001 *
1002 */
1003 @Parameter(property="doxygen.verbatimHeaders", defaultValue="true")
1004 private boolean verbatimHeaders;
1005
1006 /**
1007 * If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1008 * compounds will be generated. Enable this if the project contains a lot of
1009 * classes, structs, unions or interfaces.
1010 *
1011 */
1012 @Parameter(property="doxygen.alphabeticalIndex", defaultValue="true")
1013 private boolean alphabeticalIndex;
1014
1015 /**
1016 * If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then the
1017 * COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1018 * which this list will be split (can be a number in the range [1..20])
1019 *
1020 */
1021 @Parameter(property="doxygen.colsInAlphaIndex", defaultValue="5")
1022 private Integer colsInAlphaIndex;
1023
1024 /**
1025 * In case all classes in a project start with a common prefix, all classes
1026 * will be put under the same header in the alphabetical index. The
1027 * IGNORE_PREFIX tag can be used to specify one or more prefixes that should
1028 * be ignored while generating the index headers.
1029 *
1030 */
1031 @Parameter(property="doxygen.ignorePrefix")
1032 private String ignorePrefix;
1033
1034 /**
1035 * If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1036 * generate HTML output.
1037 *
1038 */
1039 @Parameter(property="doxygen.generateHtml", defaultValue="true")
1040 private boolean generateHtml;
1041
1042 /**
1043 * The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1044 * If a relative path is entered the value of OUTPUT_DIRECTORY will be put
1045 * in front of it. If left blank `html' will be used as the default path.
1046 *
1047 */
1048 @Parameter(property="doxygen.htmlOutput", defaultValue="doxygen")
1049 private String htmlOutput;
1050
1051 /**
1052 * The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1053 * each generated HTML page (for example: .htm,.php,.asp). If it is left
1054 * blank doxygen will generate files with .html extension.
1055 *
1056 */
1057 @Parameter(property="doxygen.htmlFileExtension", defaultValue=".html")
1058 private String htmlFileExtension;
1059
1060 /**
1061 * The HTML_HEADER tag can be used to specify a personal HTML header for
1062 * each generated HTML page. If it is left blank doxygen will generate a
1063 * standard header.
1064 *
1065 */
1066 @Parameter(property="doxygen.htmlHeader")
1067 private String htmlHeader;
1068
1069 /**
1070 * The HTML_FOOTER tag can be used to specify a personal HTML footer for
1071 * each generated HTML page. If it is left blank doxygen will generate a
1072 * standard footer.
1073 *
1074 */
1075 @Parameter(property="doxygen.htmlFooter")
1076 private String htmlFooter;
1077
1078 /**
1079 * The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1080 * style sheet that is used by each HTML page. It can be used to fine-tune
1081 * the look of the HTML output. If the tag is left blank doxygen will
1082 * generate a default style sheet. Note that doxygen will try to copy the
1083 * style sheet file to the HTML output directory, so don't put your own
1084 * stylesheet in the HTML output directory as well, or it will be erased!
1085 *
1086 */
1087 @Parameter(property="doxygen.htmlStylesheet")
1088 private String htmlStylesheet;
1089
1090 /**
1091 * If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1092 * files or namespaces will be aligned in HTML using tables. If set to NO a
1093 * bullet list will be used.
1094 *
1095 */
1096 @Parameter(property="doxygen.htmlAlignMembers", defaultValue="true")
1097 private boolean htmlAlignMembers;
1098
1099 /**
1100 * If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1101 * documentation will contain sections that can be hidden and shown after
1102 * the page has loaded. For this to work a browser that supports JavaScript
1103 * and DHTML is required (for instance Mozilla 1.0+, Firefox Netscape 6.0+,
1104 * Internet explorer 5.0+, Konqueror, or Safari).
1105 *
1106 */
1107 @Parameter(property="doxygen.htmlDynamicSections", defaultValue="true")
1108 private boolean htmlDynamicSections;
1109
1110 /**
1111 * If the GENERATE_DOCSET tag is set to YES, additional index files will be
1112 * generated that can be used as input for Apple's Xcode 3 integrated
1113 * development environment, introduced with OSX 10.5 (Leopard). To create a
1114 * documentation set, doxygen will generate a Makefile in the HTML output
1115 * directory. Running make will produce the docset in that directory and
1116 * running "make install" will install the docset in
1117 * ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1118 * it at startup. See
1119 * http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more
1120 * information.
1121 *
1122 */
1123 @Parameter(property="doxygen.generateDocset", defaultValue="false")
1124 private boolean generateDocset;
1125
1126 /**
1127 * When GENERATE_DOCSET tag is set to YES, this tag determines the name of
1128 * the feed. A documentation feed provides an umbrella under which multiple
1129 * documentation sets from a single provider (such as a company or product
1130 * suite) can be grouped.
1131 *
1132 */
1133 @Parameter(property="doxygen.docsetFeedname", defaultValue="\"Doxygen generated docs\"")
1134 private String docsetFeedname;
1135
1136 /**
1137 * When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1138 * should uniquely identify the documentation set bundle. This should be a
1139 * reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1140 * will append .docset to the name.
1141 *
1142 */
1143 @Parameter(property="doxygen.docsetBundleId", defaultValue="org.doxygen.Project")
1144 private String docsetBundleId;
1145
1146 /**
1147 * If the GENERATE_HTMLHELP tag is set to YES, additional index files will
1148 * be generated that can be used as input for tools like the Microsoft HTML
1149 * help workshop to generate a compiled HTML help file (.chm) of the
1150 * generated HTML documentation.
1151 *
1152 */
1153 @Parameter(property="doxygen.generateHtmlhelp", defaultValue="false")
1154 private boolean generateHtmlhelp;
1155
1156 /**
1157 * If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can be used
1158 * to specify the file name of the resulting .chm file. You can add a path
1159 * in front of the file if the result should not be written to the html
1160 * output directory.
1161 *
1162 */
1163 @Parameter(property="doxygen.chmFile")
1164 private String chmFile;
1165
1166 /**
1167 * If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can be
1168 * used to specify the location (absolute path including file name) of the
1169 * HTML help compiler (hhc.exe). If non-empty doxygen will try to run the
1170 * HTML help compiler on the generated index.hhp.
1171 *
1172 */
1173 @Parameter(property="doxygen.hhcLocation")
1174 private String hhcLocation;
1175
1176 /**
1177 * If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1178 * controls if a separate .chi index file is generated (YES) or that it
1179 * should be included in the master .chm file (NO).
1180 *
1181 */
1182 @Parameter(property="doxygen.generateChi", defaultValue="false")
1183 private boolean generateChi;
1184
1185 /**
1186 * If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING is
1187 * used to encode HtmlHelp index (hhk), content (hhc) and project file
1188 * content.
1189 *
1190 */
1191 @Parameter(property="doxygen.chmIndexEncoding")
1192 private String chmIndexEncoding;
1193
1194 /**
1195 * If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag controls
1196 * whether a binary table of contents is generated (YES) or a normal table
1197 * of contents (NO) in the .chm file.
1198 *
1199 */
1200 @Parameter(property="doxygen.binaryToc", defaultValue="false")
1201 private boolean binaryToc;
1202
1203 /**
1204 * The TOC_EXPAND flag can be set to YES to add extra items for group
1205 * members to the contents of the HTML help documentation and to the tree
1206 * view.
1207 *
1208 */
1209 @Parameter(property="doxygen.tocExpand", defaultValue="false")
1210 private boolean tocExpand;
1211
1212 /**
1213 * If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1214 * QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1215 * that can be used as input for Qt's qhelpgenerator to generate a Qt
1216 * Compressed Help (.qch) of the generated HTML documentation.
1217 *
1218 */
1219 @Parameter(property="doxygen.generateQhp", defaultValue="false")
1220 private boolean generateQhp;
1221
1222 /**
1223 * If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to
1224 * specify the file name of the resulting .qch file. The path specified is
1225 * relative to the HTML output folder.
1226 *
1227 */
1228 @Parameter(property="doxygen.qchFile")
1229 private String qchFile;
1230
1231 /**
1232 * The QHP_NAMESPACE tag specifies the namespace to use when generating Qt
1233 * Help Project output. For more information please see <a
1234 * href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help
1235 * Project / Namespace</a>.
1236 *
1237 */
1238 @Parameter(property="doxygen.qhpNamespace", defaultValue="org.doxygen.Project")
1239 private String qhpNamespace;
1240
1241 /**
1242 * The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1243 * Qt Help Project output. For more information please see <a
1244 * href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt
1245 * Help Project / Virtual Folders</a>.
1246 *
1247 */
1248 @Parameter(property="doxygen.qhpVirtualFolder", defaultValue="doc")
1249 private String qhpVirtualFolder;
1250
1251 /**
1252 * If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can be used
1253 * to specify the location of Qt's qhelpgenerator. If non-empty doxygen will
1254 * try to run qhelpgenerator on the generated .qhp file .
1255 *
1256 */
1257 @Parameter(property="doxygen.qhgLocation")
1258 private String qhgLocation;
1259
1260 /**
1261 * The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1262 * top of each HTML page. The value NO (the default) enables the index and
1263 * the value YES disables it.
1264 *
1265 */
1266 @Parameter(property="doxygen.disableIndex", defaultValue="false")
1267 private boolean disableIndex;
1268
1269 /**
1270 * This tag can be used to set the number of enum values (range [1..20])
1271 * that doxygen will group on one line in the generated HTML documentation.
1272 *
1273 */
1274 @Parameter(property="doxygen.enumValuesPerLine", defaultValue="4")
1275 private Integer enumValuesPerLine;
1276
1277 /**
1278 * The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1279 * structure should be generated to display hierarchical information. If the
1280 * tag value is set to FRAME, a side panel will be generated containing a
1281 * tree-like index structure (just like the one that is generated for HTML
1282 * Help). For this to work a browser that supports JavaScript, DHTML, CSS
1283 * and frames is required (for instance Mozilla 1.0+, Netscape 6.0+,
1284 * Internet explorer 5.0+, or Konqueror). Windows users are probably better
1285 * off using the HTML help feature. Other possible values for this tag are:
1286 * HIERARCHIES, which will generate the Groups, Directories, and Class
1287 * Hierarchy pages using a tree view instead of an ordered list; ALL, which
1288 * combines the behavior of FRAME and HIERARCHIES; and NONE, which disables
1289 * this behavior completely. For backwards compatibility with previous
1290 * releases of Doxygen, the values YES and NO are equivalent to FRAME and
1291 * NONE respectively.
1292 *
1293 */
1294 @Parameter(property="doxygen.generateTreeview", defaultValue="ALL")
1295 private String generateTreeview;
1296
1297 /**
1298 * If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1299 * used to set the initial width (in pixels) of the frame in which the tree
1300 * is shown.
1301 *
1302 */
1303 @Parameter(property="doxygen.treeviewWidth", defaultValue="250")
1304 private Integer treeviewWidth;
1305
1306 /**
1307 * Use this tag to change the font size of Latex formulas included as images
1308 * in the HTML documentation. The default is 10. Note that when you change
1309 * the font size after a successful doxygen run you need to manually remove
1310 * any form_*.png images from the HTML output directory to force them to be
1311 * regenerated.
1312 *
1313 */
1314 @Parameter(property="doxygen.formulaFontsize", defaultValue="10")
1315 private Integer formulaFontsize;
1316
1317 /**
1318 * If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1319 * generate Latex output.
1320 *
1321 */
1322 @Parameter(property="doxygen.generateLatex", defaultValue="false")
1323 private boolean generateLatex;
1324
1325 /**
1326 * The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1327 * If a relative path is entered the value of OUTPUT_DIRECTORY will be put
1328 * in front of it. If left blank `latex' will be used as the default path.
1329 *
1330 */
1331 @Parameter(property="doxygen.latexOutput", defaultValue="latex")
1332 private String latexOutput;
1333
1334 /**
1335 * The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to
1336 * be invoked. If left blank `latex' will be used as the default command
1337 * name.
1338 *
1339 */
1340 @Parameter(property="doxygen.latexCmdName", defaultValue="latex")
1341 private String latexCmdName;
1342
1343 /**
1344 * The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1345 * generate index for LaTeX. If left blank `makeindex' will be used as the
1346 * default command name.
1347 *
1348 */
1349 @Parameter(property="doxygen.makeindexCmdName", defaultValue="makeindex")
1350 private String makeindexCmdName;
1351
1352 /**
1353 * If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1354 * LaTeX documents. This may be useful for small projects and may help to
1355 * save some trees in general.
1356 *
1357 */
1358 @Parameter(property="doxygen.compactLatex", defaultValue="false")
1359 private boolean compactLatex;
1360
1361 /**
1362 * The PAPER_TYPE tag can be used to set the paper type that is used by the
1363 * printer. Possible values are: a4, a4wide, letter, legal and executive. If
1364 * left blank a4wide will be used.
1365 *
1366 */
1367 @Parameter(property="doxygen.paperType", defaultValue="a4wide")
1368 private String paperType;
1369
1370 /**
1371 * The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1372 * packages that should be included in the LaTeX output.
1373 *
1374 */
1375 @Parameter(property="doxygen.extraPackages")
1376 private String extraPackages;
1377
1378 /**
1379 * The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1380 * the generated latex document. The header should contain everything until
1381 * the first chapter. If it is left blank doxygen will generate a standard
1382 * header. Notice: only use this tag if you know what you are doing!
1383 *
1384 */
1385 @Parameter(property="doxygen.latexHeader")
1386 private String latexHeader;
1387
1388 /**
1389 * If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1390 * prepared for conversion to pdf (using ps2pdf). The pdf file will contain
1391 * links (just like the HTML output) instead of page references This makes
1392 * the output suitable for online browsing using a pdf viewer.
1393 *
1394 */
1395 @Parameter(property="doxygen.pdfHyperlinks", defaultValue="true")
1396 private boolean pdfHyperlinks;
1397
1398 /**
1399 * If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1400 * plain latex in the generated Makefile. Set this option to YES to get a
1401 * higher quality PDF documentation.
1402 *
1403 */
1404 @Parameter(property="doxygen.usePdflatex", defaultValue="true")
1405 private boolean usePdflatex;
1406
1407 /**
1408 * If the LATEX_BATCHMODE tag is set to YES, doxygen will add the
1409 * \\batchmode. command to the generated LaTeX files. This will instruct
1410 * LaTeX to keep running if errors occur, instead of asking the user for
1411 * help. This option is also used when generating formulas in HTML.
1412 *
1413 */
1414 @Parameter(property="doxygen.latexBatchmode", defaultValue="false")
1415 private boolean latexBatchmode;
1416
1417 /**
1418 * If LATEX_HIDE_INDICES is set to YES then doxygen will not include the
1419 * index chapters (such as File Index, Compound Index, etc.) in the output.
1420 *
1421 */
1422 @Parameter(property="doxygen.latexHideIndices", defaultValue="false")
1423 private boolean latexHideIndices;
1424
1425 /**
1426 * If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1427 * The RTF output is optimized for Word 97 and may not look very pretty with
1428 * other RTF readers or editors.
1429 *
1430 */
1431 @Parameter(property="doxygen.generateRtf", defaultValue="false")
1432 private boolean generateRtf;
1433
1434 /**
1435 * The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If
1436 * a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1437 * front of it. If left blank `rtf' will be used as the default path.
1438 *
1439 */
1440 @Parameter(property="doxygen.rtfOutput", defaultValue="rtf")
1441 private String rtfOutput;
1442
1443 /**
1444 * If the COMPACT_RTF tag is set to YES Doxygen generates more compact RTF
1445 * documents. This may be useful for small projects and may help to save
1446 * some trees in general.
1447 *
1448 */
1449 @Parameter(property="doxygen.compactRtf", defaultValue="false")
1450 private boolean compactRtf;
1451
1452 /**
1453 * If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1454 * contain hyperlink fields. The RTF file will contain links (just like the
1455 * HTML output) instead of page references. This makes the output suitable
1456 * for online browsing using WORD or other programs which support those
1457 * fields. Note: wordpad (write) and others do not support links.
1458 *
1459 */
1460 @Parameter(property="doxygen.rtfHyperlinks", defaultValue="false")
1461 private boolean rtfHyperlinks;
1462
1463 /**
1464 * Load stylesheet definitions from file. Syntax is similar to doxygen's
1465 * config file, i.e. a series of assignments. You only have to provide
1466 * replacements, missing definitions are set to their default value.
1467 *
1468 */
1469 @Parameter(property="doxygen.rtfStylesheetFile")
1470 private String rtfStylesheetFile;
1471
1472 /**
1473 * Set optional variables used in the generation of an rtf document. Syntax
1474 * is similar to doxygen's config file.
1475 *
1476 */
1477 @Parameter(property="doxygen.rtfExtensionsFile")
1478 private String rtfExtensionsFile;
1479
1480 /**
1481 * If the GENERATE_MAN tag is set to YES (the default) Doxygen will generate
1482 * man pages
1483 *
1484 */
1485 @Parameter(property="doxygen.generateMan", defaultValue="false")
1486 private boolean generateMan;
1487
1488 /**
1489 * The MAN_OUTPUT tag is used to specify where the man pages will be put. If
1490 * a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1491 * front of it. If left blank `man' will be used as the default path.
1492 *
1493 */
1494 @Parameter(property="doxygen.manOutput", defaultValue="man")
1495 private String manOutput;
1496
1497 /**
1498 * The MAN_EXTENSION tag determines the extension that is added to the
1499 * generated man pages (default is the subroutine's section .3)
1500 *
1501 */
1502 @Parameter(property="doxygen.manExtension", defaultValue=".3")
1503 private String manExtension;
1504
1505 /**
1506 * If the MAN_LINKS tag is set to YES and Doxygen generates man output, then
1507 * it will generate one additional man file for each entity documented in
1508 * the real man page(s). These additional files only source the real man
1509 * page, but without them the man command would be unable to find the
1510 * correct page. The default is NO.
1511 *
1512 */
1513 @Parameter(property="doxygen.manLinks", defaultValue="false")
1514 private boolean manLinks;
1515
1516 /**
1517 * If the GENERATE_XML tag is set to YES Doxygen will generate an XML file
1518 * that captures the structure of the code including all documentation.
1519 *
1520 */
1521 @Parameter(property="doxygen.generateXml", defaultValue="false")
1522 private boolean generateXml;
1523
1524 /**
1525 * The XML_OUTPUT tag is used to specify where the XML pages will be put. If
1526 * a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1527 * front of it. If left blank `xml' will be used as the default path.
1528 *
1529 */
1530 @Parameter(property="doxygen.xmlOutput", defaultValue="xml")
1531 private String xmlOutput;
1532
1533 /**
1534 * The XML_SCHEMA tag can be used to specify an XML schema, which can be
1535 * used by a validating XML parser to check the syntax of the XML files.
1536 *
1537 */
1538 @Parameter(property="doxygen.xmlSchema")
1539 private String xmlSchema;
1540
1541 /**
1542 * The XML_DTD tag can be used to specify an XML DTD, which can be used by a
1543 * validating XML parser to check the syntax of the XML files.
1544 *
1545 */
1546 @Parameter(property="doxygen.xmlDtd")
1547 private String xmlDtd;
1548
1549 /**
1550 * If the XML_PROGRAMLISTING tag is set to YES Doxygen will dump the program
1551 * listings (including syntax highlighting and cross-referencing
1552 * information) to the XML output. Note that enabling this will
1553 * significantly increase the size of the XML output.
1554 *
1555 */
1556 @Parameter(property="doxygen.xmlProgramlisting", defaultValue="true")
1557 private boolean xmlProgramlisting;
1558
1559 /**
1560 * If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will generate an
1561 * AutoGen Definitions (see autogen.sf.net) file that captures the structure
1562 * of the code including all documentation. Note that this feature is still
1563 * experimental and incomplete at the moment.
1564 *
1565 */
1566 @Parameter(property="doxygen.generateAutogenDef", defaultValue="false")
1567 private boolean generateAutogenDef;
1568
1569 /**
1570 * If the GENERATE_PERLMOD tag is set to YES Doxygen will generate a Perl
1571 * module file that captures the structure of the code including all
1572 * documentation. Note that this feature is still experimental and
1573 * incomplete at the moment.
1574 *
1575 */
1576 @Parameter(property="doxygen.generatePerlmod", defaultValue="false")
1577 private boolean generatePerlmod;
1578
1579 /**
1580 * If the PERLMOD_LATEX tag is set to YES Doxygen will generate the
1581 * necessary Makefile rules, Perl scripts and LaTeX code to be able to
1582 * generate PDF and DVI output from the Perl module output.
1583 *
1584 */
1585 @Parameter(property="doxygen.perlmodLatex", defaultValue="false")
1586 private boolean perlmodLatex;
1587
1588 /**
1589 * If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1590 * nicely formatted so it can be parsed by a human reader. This is useful if
1591 * you want to understand what is going on. On the other hand, if this tag
1592 * is set to NO the size of the Perl module output will be much smaller and
1593 * Perl will parse it just the same.
1594 *
1595 */
1596 @Parameter(property="doxygen.perlmodPretty", defaultValue="true")
1597 private boolean perlmodPretty;
1598
1599 /**
1600 * The names of the make variables in the generated doxyrules.make file are
1601 * prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is
1602 * useful so different doxyrules.make files included by the same Makefile
1603 * don't overwrite each other's variables.
1604 *
1605 */
1606 @Parameter(property="doxygen.perlmodMakevarPrefix")
1607 private String perlmodMakevarPrefix;
1608
1609 /**
1610 * If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1611 * evaluate all C-preprocessor directives found in the sources and include
1612 * files.
1613 *
1614 */
1615 @Parameter(property="doxygen.enablePreprocessing", defaultValue="true")
1616 private boolean enablePreprocessing;
1617
1618 /**
1619 * If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1620 * names in the source code. If set to NO (the default) only conditional
1621 * compilation will be performed. Macro expansion can be done in a
1622 * controlled way by setting EXPAND_ONLY_PREDEF to YES.
1623 *
1624 */
1625 @Parameter(property="doxygen.macroExpansion", defaultValue="false")
1626 private boolean macroExpansion;
1627
1628 /**
1629 * If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1630 * then the macro expansion is limited to the macros specified with the
1631 * PREDEFINED and EXPAND_AS_DEFINED tags.
1632 *
1633 */
1634 @Parameter(property="doxygen.expandOnlyPredef", defaultValue="false")
1635 private boolean expandOnlyPredef;
1636
1637 /**
1638 * If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1639 * in the INCLUDE_PATH (see below) will be search if a #include is found.
1640 *
1641 */
1642 @Parameter(property="doxygen.searchIncludes", defaultValue="true")
1643 private boolean searchIncludes;
1644
1645 /**
1646 * The INCLUDE_PATH tag can be used to specify one or more directories that
1647 * contain include files that are not input files but should be processed by
1648 * the preprocessor.
1649 *
1650 */
1651 @Parameter(property="doxygen.includePath")
1652 private String includePath;
1653
1654 /**
1655 * You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1656 * patterns (like *.h and *.hpp) to filter out the header-files in the
1657 * directories. If left blank, the patterns specified with FILE_PATTERNS
1658 * will be used.
1659 *
1660 */
1661 @Parameter(property="doxygen.includeFilePatterns")
1662 private String includeFilePatterns;
1663
1664 /**
1665 * The PREDEFINED tag can be used to specify one or more macro names that
1666 * are defined before the preprocessor is started (similar to the -D option
1667 * of gcc). The argument of the tag is a list of macros of the form: name or
1668 * name=definition (no spaces). If the definition and the = are omitted =1
1669 * is assumed. To prevent a macro definition from being undefined via #undef
1670 * or recursively expanded use the := operator instead of the = operator.
1671 *
1672 */
1673 @Parameter(property="doxygen.predefined")
1674 private String predefined;
1675
1676 /**
1677 * If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1678 * this tag can be used to specify a list of macro names that should be
1679 * expanded. The macro definition that is found in the sources will be used.
1680 * Use the PREDEFINED tag if you want to use a different macro definition.
1681 *
1682 */
1683 @Parameter(property="doxygen.expandAsDefined")
1684 private String expandAsDefined;
1685
1686 /**
1687 * If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1688 * doxygen's preprocessor will remove all function-like macros that are
1689 * alone on a line, have an all uppercase name, and do not end with a
1690 * semicolon. Such function macros are typically used for boiler-plate code,
1691 * and will confuse the parser if not removed.
1692 *
1693 */
1694 @Parameter(property="doxygen.skipFunctionMacros", defaultValue="true")
1695 private boolean skipFunctionMacros;
1696
1697 /**
1698 * The TAGFILES option can be used to specify one or more tagfiles.
1699 * Optionally an initial location of the external documentation can be added
1700 * for each tagfile. The format of a tag file without this location is as
1701 * follows: TAGFILES = file1 file2 ... Adding location for the tag files is
1702 * done as follows: TAGFILES = file1=loc1 "file2 = loc2" ... where "loc1"
1703 * and "loc2" can be relative or absolute paths or URLs. If a location is
1704 * present for each tag, the installdox tool does not have to be run to
1705 * correct the links. Note that each tag file must have a unique name (where
1706 * the name does NOT include the path) If a tag file is not located in the
1707 * directory in which doxygen is run, you must also specify the path to the
1708 * tagfile here.
1709 *
1710 */
1711 @Parameter(property="doxygen.tagfiles")
1712 private String tagfiles;
1713
1714 /**
1715 * When a file name is specified after GENERATE_TAGFILE, doxygen will create
1716 * a tag file that is based on the input files it reads.
1717 *
1718 */
1719 @Parameter(property="doxygen.generateTagfile")
1720 private String generateTagfile;
1721
1722 /**
1723 * If the ALLEXTERNALS tag is set to YES all external classes will be listed
1724 * in the class index. If set to NO only the inherited external classes will
1725 * be listed.
1726 *
1727 */
1728 @Parameter(property="doxygen.allexternals", defaultValue="false")
1729 private boolean allexternals;
1730
1731 /**
1732 * If the EXTERNAL_GROUPS tag is set to YES all external groups will be
1733 * listed in the modules index. If set to NO, only the current project's
1734 * groups will be listed.
1735 *
1736 */
1737 @Parameter(property="doxygen.externalGroups", defaultValue="true")
1738 private boolean externalGroups;
1739
1740 /**
1741 * The PERL_PATH should be the absolute path and name of the perl script
1742 * interpreter (i.e. the result of `which perl').
1743 *
1744 */
1745 @Parameter(property="doxygen.perlPath", defaultValue="/usr/bin/perl")
1746 private String perlPath;
1747
1748 /**
1749 * If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1750 * generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with
1751 * base or super classes. Setting the tag to NO turns the diagrams off. Note
1752 * that this option is superseded by the HAVE_DOT option below. This is only
1753 * a fallback. It is recommended to install and use dot, since it yields
1754 * more powerful graphs.
1755 *
1756 */
1757 @Parameter(property="doxygen.classDiagrams", defaultValue="true")
1758 private boolean classDiagrams;
1759
1760 /**
1761 * You can define message sequence charts within doxygen comments using the
1762 * \msc command. Doxygen will then run the mscgen tool (see
1763 * http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in
1764 * the documentation. The MSCGEN_PATH tag allows you to specify the
1765 * directory where the mscgen tool resides. If left empty the tool is
1766 * assumed to be found in the default search path.
1767 *
1768 */
1769 @Parameter(property="doxygen.mscgenPath")
1770 private String mscgenPath;
1771
1772 /**
1773 * If set to YES, the inheritance and collaboration graphs will hide
1774 * inheritance and usage relations if the target is undocumented or is not a
1775 * class.
1776 *
1777 */
1778 @Parameter(property="doxygen.hideUndocRelations", defaultValue="true")
1779 private boolean hideUndocRelations;
1780
1781 /**
1782 * If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool
1783 * is available from the path. This tool is part of Graphviz, a graph
1784 * visualization toolkit from AT&T and Lucent Bell Labs. The other options
1785 * in this section have no effect if this option is set to NO (the default)
1786 *
1787 */
1788 @Parameter(property="doxygen.haveDot", defaultValue="true")
1789 private boolean haveDot;
1790
1791 /**
1792 * By default doxygen will write a font called FreeSans.ttf to the output
1793 * directory and reference it in all dot files that doxygen generates. This
1794 * font does not include all possible unicode characters however, so when
1795 * you need these (or just want a differently looking font) you can specify
1796 * the font name using DOT_FONTNAME. You need need to make sure dot is able
1797 * to find the font, which can be done by putting it in a standard location
1798 * or by setting the DOTFONTPATH environment variable or by setting
1799 * DOT_FONTPATH to the directory containing the font.
1800 *
1801 */
1802 @Parameter(property="doxygen.dotFontname", defaultValue="FreeSans")
1803 private String dotFontname;
1804
1805 /**
1806 * The DOT_FONTSIZE tag can be used to set the size of the font of dot
1807 * graphs. The default size is 10pt.
1808 *
1809 */
1810 @Parameter(property="doxygen.dotFontsize", defaultValue="10")
1811 private Integer dotFontsize;
1812
1813 /**
1814 * By default doxygen will tell dot to use the output directory to look for
1815 * the FreeSans.ttf font (which doxygen will put there itself). If you
1816 * specify a different font using DOT_FONTNAME you can set the path where
1817 * dot can find it using this tag.
1818 *
1819 */
1820 @Parameter(property="doxygen.dotFontpath")
1821 private String dotFontpath;
1822
1823 /**
1824 * If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1825 * generate a graph for each documented class showing the direct and
1826 * indirect inheritance relations. Setting this tag to YES will force the
1827 * the CLASS_DIAGRAMS tag to NO.
1828 *
1829 */
1830 @Parameter(property="doxygen.classGraph", defaultValue="true")
1831 private boolean classGraph;
1832
1833 /**
1834 * If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1835 * will generate a graph for each documented class showing the direct and
1836 * indirect implementation dependencies (inheritance, containment, and class
1837 * references variables) of the class with other documented classes.
1838 *
1839 */
1840 @Parameter(property="doxygen.collaborationGraph", defaultValue="true")
1841 private boolean collaborationGraph;
1842
1843 /**
1844 * If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen will
1845 * generate a graph for groups, showing the direct groups dependencies
1846 *
1847 */
1848 @Parameter(property="doxygen.groupGraphs", defaultValue="true")
1849 private boolean groupGraphs;
1850
1851 /**
1852 * If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1853 * collaboration diagrams in a style similar to the OMG's Unified Modeling
1854 * Language.
1855 *
1856 */
1857 @Parameter(property="doxygen.umlLook", defaultValue="false")
1858 private boolean umlLook;
1859
1860 /**
1861 * If set to YES, the inheritance and collaboration graphs will show the
1862 * relations between templates and their instances.
1863 *
1864 */
1865 @Parameter(property="doxygen.templateRelations", defaultValue="false")
1866 private boolean templateRelations;
1867
1868 /**
1869 * If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1870 * tags are set to YES then doxygen will generate a graph for each
1871 * documented file showing the direct and indirect include dependencies of
1872 * the file with other documented files.
1873 *
1874 */
1875 @Parameter(property="doxygen.includeGraph", defaultValue="true")
1876 private boolean includeGraph;
1877
1878 /**
1879 * If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1880 * HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1881 * documented header file showing the documented files that directly or
1882 * indirectly include this file.
1883 *
1884 */
1885 @Parameter(property="doxygen.includedByGraph", defaultValue="true")
1886 private boolean includedByGraph;
1887
1888 /**
1889 * If the CALL_GRAPH and HAVE_DOT options are set to YES then doxygen will
1890 * generate a call dependency graph for every global function or class
1891 * method. Note that enabling this option will significantly increase the
1892 * time of a run. So in most cases it will be better to enable call graphs
1893 * for selected functions only using the \callgraph command.
1894 *
1895 */
1896 @Parameter(property="doxygen.callGraph", defaultValue="false")
1897 private boolean callGraph;
1898
1899 /**
1900 * If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1901 * generate a caller dependency graph for every global function or class
1902 * method. Note that enabling this option will significantly increase the
1903 * time of a run. So in most cases it will be better to enable caller graphs
1904 * for selected functions only using the \callergraph command.
1905 *
1906 */
1907 @Parameter(property="doxygen.callerGraph", defaultValue="false")
1908 private boolean callerGraph;
1909
1910 /**
1911 * If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1912 * will graphical hierarchy of all classes instead of a textual one.
1913 *
1914 */
1915 @Parameter(property="doxygen.graphicalHierarchy", defaultValue="true")
1916 private boolean graphicalHierarchy;
1917
1918 /**
1919 * If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1920 * then doxygen will show the dependencies a directory has on other
1921 * directories in a graphical way. The dependency relations are determined
1922 * by the #include relations between the files in the directories.
1923 *
1924 */
1925 @Parameter(property="doxygen.directoryGraph", defaultValue="true")
1926 private boolean directoryGraph;
1927
1928 /**
1929 * The DOT_IMAGE_FORMAT tag can be used to set the image format of the
1930 * images generated by dot. Possible values are png, jpg, or gif If left
1931 * blank png will be used.
1932 *
1933 */
1934 @Parameter(property="doxygen.dotImageFormat", defaultValue="png")
1935 private String dotImageFormat;
1936
1937 /**
1938 * The tag DOT_PATH can be used to specify the path where the dot tool can
1939 * be found. If left blank, it is assumed the dot tool can be found in the
1940 * path.
1941 *
1942 */
1943 @Parameter(property="doxygen.dotPath", defaultValue="/usr/bin")
1944 private String dotPath;
1945
1946 /**
1947 * The DOTFILE_DIRS tag can be used to specify one or more directories that
1948 * contain dot files that are included in the documentation (see the
1949 * \dotfile command).
1950 *
1951 */
1952 @Parameter(property="doxygen.dotfileDirs")
1953 private String dotfileDirs;
1954
1955 /**
1956 * The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1957 * nodes that will be shown in the graph. If the number of nodes in a graph
1958 * becomes larger than this value, doxygen will truncate the graph, which is
1959 * visualized by representing a node as a red box. Note that doxygen if the
1960 * number of direct children of the root node in a graph is already larger
1961 * than DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also
1962 * note that the size of a graph can be further restricted by
1963 * MAX_DOT_GRAPH_DEPTH.
1964 *
1965 */
1966 @Parameter(property="doxygen.dotGraphMaxNodes", defaultValue="50")
1967 private Integer dotGraphMaxNodes;
1968
1969 /**
1970 * The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1971 * graphs generated by dot. A depth value of 3 means that only nodes
1972 * reachable from the root by following a path via at most 3 edges will be
1973 * shown. Nodes that lay further from the root node will be omitted. Note
1974 * that setting this option to 1 or 2 may greatly reduce the computation
1975 * time needed for large code bases. Also note that the size of a graph can
1976 * be further restricted by DOT_GRAPH_MAX_NODES. Using a depth of 0 means no
1977 * depth restriction.
1978 *
1979 */
1980 @Parameter(property="doxygen.maxDotGraphDepth", defaultValue="0")
1981 private Integer maxDotGraphDepth;
1982
1983 /**
1984 * Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1985 * background. This is disabled by default, because dot on Windows does not
1986 * seem to support this out of the box. Warning: Depending on the platform
1987 * used, enabling this option may lead to badly anti-aliased labels on the
1988 * edges of a graph (i.e. they become hard to read).
1989 *
1990 */
1991 @Parameter(property="doxygen.dotTransparent", defaultValue="true")
1992 private boolean dotTransparent;
1993
1994 /**
1995 * Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple
1996 * output files in one run (i.e. multiple -o and -T options on the command
1997 * line). This makes dot run faster, but since only newer versions of dot
1998 * (>1.8.10) support this, this feature is disabled by default.
1999 *
2000 */
2001 @Parameter(property="doxygen.dotMultiTargets", defaultValue="true")
2002 private boolean dotMultiTargets;
2003
2004 /**
2005 * If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2006 * generate a legend page explaining the meaning of the various boxes and
2007 * arrows in the dot generated graphs.
2008 *
2009 */
2010 @Parameter(property="doxygen.generateLegend", defaultValue="true")
2011 private boolean generateLegend;
2012
2013 /**
2014 * If the DOT_CLEANUP tag is set to YES (the default) Doxygen will remove
2015 * the intermediate dot files that are used to generate the various graphs.
2016 *
2017 */
2018 @Parameter(property="doxygen.dotCleanup", defaultValue="true")
2019 private boolean dotCleanup;
2020
2021 /**
2022 * The SEARCHENGINE tag specifies whether or not a search engine should be
2023 * used. If set to NO the values of all tags below this one will be ignored.
2024 *
2025 */
2026 @Parameter(property="doxygen.searchengine", defaultValue="false")
2027 private boolean searchengine;
2028
2029 public File getConfigurationFile() {
2030 return configurationFile;
2031 }
2032
2033 public void setConfigurationFile(File configurationFile) {
2034 this.configurationFile = configurationFile;
2035 }
2036
2037 public String getDoxyfileEncoding() {
2038 return doxyfileEncoding;
2039 }
2040
2041 public void setDoxyfileEncoding(String doxyfileEncoding) {
2042 this.doxyfileEncoding = doxyfileEncoding;
2043 }
2044
2045 public String getProjectName() {
2046 return projectName;
2047 }
2048
2049 public void setProjectName(String projectName) {
2050 this.projectName = projectName;
2051 }
2052
2053 public String getProjectNumber() {
2054 return projectNumber;
2055 }
2056
2057 public void setProjectNumber(String projectNumber) {
2058 this.projectNumber = projectNumber;
2059 }
2060
2061 // public String getOutputDirectory() {
2062 // return outputDirectory;
2063 // }
2064 //
2065 // public void setOutputDirectory(String outputDirectory) {
2066 // this.outputDirectory = outputDirectory;
2067 // }
2068
2069 public boolean isCreateSubdirs() {
2070 return createSubdirs;
2071 }
2072
2073 public void setCreateSubdirs(boolean createSubdirs) {
2074 this.createSubdirs = createSubdirs;
2075 }
2076
2077 public String getOutputLanguage() {
2078 return outputLanguage;
2079 }
2080
2081 public void setOutputLanguage(String outputLanguage) {
2082 this.outputLanguage = outputLanguage;
2083 }
2084
2085 public boolean isBriefMemberDesc() {
2086 return briefMemberDesc;
2087 }
2088
2089 public void setBriefMemberDesc(boolean briefMemberDesc) {
2090 this.briefMemberDesc = briefMemberDesc;
2091 }
2092
2093 public boolean isRepeatBrief() {
2094 return repeatBrief;
2095 }
2096
2097 public void setRepeatBrief(boolean repeatBrief) {
2098 this.repeatBrief = repeatBrief;
2099 }
2100
2101 public String getAbbreviateBrief() {
2102 return abbreviateBrief;
2103 }
2104
2105 public void setAbbreviateBrief(String abbreviateBrief) {
2106 this.abbreviateBrief = abbreviateBrief;
2107 }
2108
2109 public boolean isAlwaysDetailedSec() {
2110 return alwaysDetailedSec;
2111 }
2112
2113 public void setAlwaysDetailedSec(boolean alwaysDetailedSec) {
2114 this.alwaysDetailedSec = alwaysDetailedSec;
2115 }
2116
2117 public boolean isInlineInheritedMemb() {
2118 return inlineInheritedMemb;
2119 }
2120
2121 public void setInlineInheritedMemb(boolean inlineInheritedMemb) {
2122 this.inlineInheritedMemb = inlineInheritedMemb;
2123 }
2124
2125 public boolean isFullPathNames() {
2126 return fullPathNames;
2127 }
2128
2129 public void setFullPathNames(boolean fullPathNames) {
2130 this.fullPathNames = fullPathNames;
2131 }
2132
2133 public String getStripFromPath() {
2134 return stripFromPath;
2135 }
2136
2137 public void setStripFromPath(String stripFromPath) {
2138 this.stripFromPath = stripFromPath;
2139 }
2140
2141 public String getStripFromIncPath() {
2142 return stripFromIncPath;
2143 }
2144
2145 public void setStripFromIncPath(String stripFromIncPath) {
2146 this.stripFromIncPath = stripFromIncPath;
2147 }
2148
2149 public boolean isShortNames() {
2150 return shortNames;
2151 }
2152
2153 public void setShortNames(boolean shortNames) {
2154 this.shortNames = shortNames;
2155 }
2156
2157 public boolean isJavadocAutobrief() {
2158 return javadocAutobrief;
2159 }
2160
2161 public void setJavadocAutobrief(boolean javadocAutobrief) {
2162 this.javadocAutobrief = javadocAutobrief;
2163 }
2164
2165 public boolean isQtAutobrief() {
2166 return qtAutobrief;
2167 }
2168
2169 public void setQtAutobrief(boolean qtAutobrief) {
2170 this.qtAutobrief = qtAutobrief;
2171 }
2172
2173 public boolean isMultilineCppIsBrief() {
2174 return multilineCppIsBrief;
2175 }
2176
2177 public void setMultilineCppIsBrief(boolean multilineCppIsBrief) {
2178 this.multilineCppIsBrief = multilineCppIsBrief;
2179 }
2180
2181 public boolean isInheritDocs() {
2182 return inheritDocs;
2183 }
2184
2185 public void setInheritDocs(boolean inheritDocs) {
2186 this.inheritDocs = inheritDocs;
2187 }
2188
2189 public boolean isSeparateMemberPages() {
2190 return separateMemberPages;
2191 }
2192
2193 public void setSeparateMemberPages(boolean separateMemberPages) {
2194 this.separateMemberPages = separateMemberPages;
2195 }
2196
2197 public Integer getTabSize() {
2198 return tabSize;
2199 }
2200
2201 public void setTabSize(Integer tabSize) {
2202 this.tabSize = tabSize;
2203 }
2204
2205 public String getAliases() {
2206 return aliases;
2207 }
2208
2209 public void setAliases(String aliases) {
2210 this.aliases = aliases;
2211 }
2212
2213 public boolean isOptimizeOutputForC() {
2214 return optimizeOutputForC;
2215 }
2216
2217 public void setOptimizeOutputForC(boolean optimizeOutputForC) {
2218 this.optimizeOutputForC = optimizeOutputForC;
2219 }
2220
2221 public boolean isOptimizeOutputJava() {
2222 return optimizeOutputJava;
2223 }
2224
2225 public void setOptimizeOutputJava(boolean optimizeOutputJava) {
2226 this.optimizeOutputJava = optimizeOutputJava;
2227 }
2228
2229 public boolean isOptimizeForFortran() {
2230 return optimizeForFortran;
2231 }
2232
2233 public void setOptimizeForFortran(boolean optimizeForFortran) {
2234 this.optimizeForFortran = optimizeForFortran;
2235 }
2236
2237 public boolean isOptimizeOutputVhdl() {
2238 return optimizeOutputVhdl;
2239 }
2240
2241 public void setOptimizeOutputVhdl(boolean optimizeOutputVhdl) {
2242 this.optimizeOutputVhdl = optimizeOutputVhdl;
2243 }
2244
2245 public boolean isBuiltinStlSupport() {
2246 return builtinStlSupport;
2247 }
2248
2249 public void setBuiltinStlSupport(boolean builtinStlSupport) {
2250 this.builtinStlSupport = builtinStlSupport;
2251 }
2252
2253 public boolean isCppCliSupport() {
2254 return cppCliSupport;
2255 }
2256
2257 public void setCppCliSupport(boolean cppCliSupport) {
2258 this.cppCliSupport = cppCliSupport;
2259 }
2260
2261 public boolean isSipSupport() {
2262 return sipSupport;
2263 }
2264
2265 public void setSipSupport(boolean sipSupport) {
2266 this.sipSupport = sipSupport;
2267 }
2268
2269 public boolean isIdlPropertySupport() {
2270 return idlPropertySupport;
2271 }
2272
2273 public void setIdlPropertySupport(boolean idlPropertySupport) {
2274 this.idlPropertySupport = idlPropertySupport;
2275 }
2276
2277 public boolean isDistributeGroupDoc() {
2278 return distributeGroupDoc;
2279 }
2280
2281 public void setDistributeGroupDoc(boolean distributeGroupDoc) {
2282 this.distributeGroupDoc = distributeGroupDoc;
2283 }
2284
2285 public boolean isSubgrouping() {
2286 return subgrouping;
2287 }
2288
2289 public void setSubgrouping(boolean subgrouping) {
2290 this.subgrouping = subgrouping;
2291 }
2292
2293 public boolean isTypedefHidesStruct() {
2294 return typedefHidesStruct;
2295 }
2296
2297 public void setTypedefHidesStruct(boolean typedefHidesStruct) {
2298 this.typedefHidesStruct = typedefHidesStruct;
2299 }
2300
2301 public Integer getSymbolCacheSize() {
2302 return symbolCacheSize;
2303 }
2304
2305 public void setSymbolCacheSize(Integer symbolCacheSize) {
2306 this.symbolCacheSize = symbolCacheSize;
2307 }
2308
2309 public boolean isExtractAll() {
2310 return extractAll;
2311 }
2312
2313 public void setExtractAll(boolean extractAll) {
2314 this.extractAll = extractAll;
2315 }
2316
2317 public boolean isExtractPrivate() {
2318 return extractPrivate;
2319 }
2320
2321 public void setExtractPrivate(boolean extractPrivate) {
2322 this.extractPrivate = extractPrivate;
2323 }
2324
2325 public boolean isExtractStatic() {
2326 return extractStatic;
2327 }
2328
2329 public void setExtractStatic(boolean extractStatic) {
2330 this.extractStatic = extractStatic;
2331 }
2332
2333 public boolean isExtractLocalClasses() {
2334 return extractLocalClasses;
2335 }
2336
2337 public void setExtractLocalClasses(boolean extractLocalClasses) {
2338 this.extractLocalClasses = extractLocalClasses;
2339 }
2340
2341 public boolean isExtractLocalMethods() {
2342 return extractLocalMethods;
2343 }
2344
2345 public void setExtractLocalMethods(boolean extractLocalMethods) {
2346 this.extractLocalMethods = extractLocalMethods;
2347 }
2348
2349 public boolean isExtractAnonNspaces() {
2350 return extractAnonNspaces;
2351 }
2352
2353 public void setExtractAnonNspaces(boolean extractAnonNspaces) {
2354 this.extractAnonNspaces = extractAnonNspaces;
2355 }
2356
2357 public boolean isHideUndocMembers() {
2358 return hideUndocMembers;
2359 }
2360
2361 public void setHideUndocMembers(boolean hideUndocMembers) {
2362 this.hideUndocMembers = hideUndocMembers;
2363 }
2364
2365 public boolean isHideUndocClasses() {
2366 return hideUndocClasses;
2367 }
2368
2369 public void setHideUndocClasses(boolean hideUndocClasses) {
2370 this.hideUndocClasses = hideUndocClasses;
2371 }
2372
2373 public boolean isHideFriendCompounds() {
2374 return hideFriendCompounds;
2375 }
2376
2377 public void setHideFriendCompounds(boolean hideFriendCompounds) {
2378 this.hideFriendCompounds = hideFriendCompounds;
2379 }
2380
2381 public boolean isHideInBodyDocs() {
2382 return hideInBodyDocs;
2383 }
2384
2385 public void setHideInBodyDocs(boolean hideInBodyDocs) {
2386 this.hideInBodyDocs = hideInBodyDocs;
2387 }
2388
2389 public boolean isInternalDocs() {
2390 return internalDocs;
2391 }
2392
2393 public void setInternalDocs(boolean internalDocs) {
2394 this.internalDocs = internalDocs;
2395 }
2396
2397 public boolean isCaseSenseNames() {
2398 return caseSenseNames;
2399 }
2400
2401 public void setCaseSenseNames(boolean caseSenseNames) {
2402 this.caseSenseNames = caseSenseNames;
2403 }
2404
2405 public boolean isHideScopeNames() {
2406 return hideScopeNames;
2407 }
2408
2409 public void setHideScopeNames(boolean hideScopeNames) {
2410 this.hideScopeNames = hideScopeNames;
2411 }
2412
2413 public boolean isShowIncludeFiles() {
2414 return showIncludeFiles;
2415 }
2416
2417 public void setShowIncludeFiles(boolean showIncludeFiles) {
2418 this.showIncludeFiles = showIncludeFiles;
2419 }
2420
2421 public boolean isInlineInfo() {
2422 return inlineInfo;
2423 }
2424
2425 public void setInlineInfo(boolean inlineInfo) {
2426 this.inlineInfo = inlineInfo;
2427 }
2428
2429 public boolean isSortMemberDocs() {
2430 return sortMemberDocs;
2431 }
2432
2433 public void setSortMemberDocs(boolean sortMemberDocs) {
2434 this.sortMemberDocs = sortMemberDocs;
2435 }
2436
2437 public boolean isSortBriefDocs() {
2438 return sortBriefDocs;
2439 }
2440
2441 public void setSortBriefDocs(boolean sortBriefDocs) {
2442 this.sortBriefDocs = sortBriefDocs;
2443 }
2444
2445 public boolean isSortGroupNames() {
2446 return sortGroupNames;
2447 }
2448
2449 public void setSortGroupNames(boolean sortGroupNames) {
2450 this.sortGroupNames = sortGroupNames;
2451 }
2452
2453 public boolean isSortByScopeName() {
2454 return sortByScopeName;
2455 }
2456
2457 public void setSortByScopeName(boolean sortByScopeName) {
2458 this.sortByScopeName = sortByScopeName;
2459 }
2460
2461 public boolean isGenerateTodolist() {
2462 return generateTodolist;
2463 }
2464
2465 public void setGenerateTodolist(boolean generateTodolist) {
2466 this.generateTodolist = generateTodolist;
2467 }
2468
2469 public boolean isGenerateTestlist() {
2470 return generateTestlist;
2471 }
2472
2473 public void setGenerateTestlist(boolean generateTestlist) {
2474 this.generateTestlist = generateTestlist;
2475 }
2476
2477 public boolean isGenerateBuglist() {
2478 return generateBuglist;
2479 }
2480
2481 public void setGenerateBuglist(boolean generateBuglist) {
2482 this.generateBuglist = generateBuglist;
2483 }
2484
2485 public boolean isGenerateDeprecatedlist() {
2486 return generateDeprecatedlist;
2487 }
2488
2489 public void setGenerateDeprecatedlist(boolean generateDeprecatedlist) {
2490 this.generateDeprecatedlist = generateDeprecatedlist;
2491 }
2492
2493 public String getEnabledSections() {
2494 return enabledSections;
2495 }
2496
2497 public void setEnabledSections(String enabledSections) {
2498 this.enabledSections = enabledSections;
2499 }
2500
2501 public Integer getMaxInitializerLines() {
2502 return maxInitializerLines;
2503 }
2504
2505 public void setMaxInitializerLines(Integer maxInitializerLines) {
2506 this.maxInitializerLines = maxInitializerLines;
2507 }
2508
2509 public boolean isShowUsedFiles() {
2510 return showUsedFiles;
2511 }
2512
2513 public void setShowUsedFiles(boolean showUsedFiles) {
2514 this.showUsedFiles = showUsedFiles;
2515 }
2516
2517 public boolean isShowDirectories() {
2518 return showDirectories;
2519 }
2520
2521 public void setShowDirectories(boolean showDirectories) {
2522 this.showDirectories = showDirectories;
2523 }
2524
2525 public boolean isShowFiles() {
2526 return showFiles;
2527 }
2528
2529 public void setShowFiles(boolean showFiles) {
2530 this.showFiles = showFiles;
2531 }
2532
2533 public boolean isShowNamespaces() {
2534 return showNamespaces;
2535 }
2536
2537 public void setShowNamespaces(boolean showNamespaces) {
2538 this.showNamespaces = showNamespaces;
2539 }
2540
2541 public String getFileVersionFilter() {
2542 return fileVersionFilter;
2543 }
2544
2545 public void setFileVersionFilter(String fileVersionFilter) {
2546 this.fileVersionFilter = fileVersionFilter;
2547 }
2548
2549 public String getLayoutFile() {
2550 return layoutFile;
2551 }
2552
2553 public void setLayoutFile(String layoutFile) {
2554 this.layoutFile = layoutFile;
2555 }
2556
2557 public boolean isQuiet() {
2558 return quiet;
2559 }
2560
2561 public void setQuiet(boolean quiet) {
2562 this.quiet = quiet;
2563 }
2564
2565 public boolean isWarnings() {
2566 return warnings;
2567 }
2568
2569 public void setWarnings(boolean warnings) {
2570 this.warnings = warnings;
2571 }
2572
2573 public boolean isWarnIfUndocumented() {
2574 return warnIfUndocumented;
2575 }
2576
2577 public void setWarnIfUndocumented(boolean warnIfUndocumented) {
2578 this.warnIfUndocumented = warnIfUndocumented;
2579 }
2580
2581 public boolean isWarnIfDocError() {
2582 return warnIfDocError;
2583 }
2584
2585 public void setWarnIfDocError(boolean warnIfDocError) {
2586 this.warnIfDocError = warnIfDocError;
2587 }
2588
2589 public boolean isWarnNoParamdoc() {
2590 return warnNoParamdoc;
2591 }
2592
2593 public void setWarnNoParamdoc(boolean warnNoParamdoc) {
2594 this.warnNoParamdoc = warnNoParamdoc;
2595 }
2596
2597 public String getWarnFormat() {
2598 return warnFormat;
2599 }
2600
2601 public void setWarnFormat(String warnFormat) {
2602 this.warnFormat = warnFormat;
2603 }
2604
2605 public String getWarnLogfile() {
2606 return warnLogfile;
2607 }
2608
2609 public void setWarnLogfile(String warnLogfile) {
2610 this.warnLogfile = warnLogfile;
2611 }
2612
2613 public String getInput() {
2614 return input;
2615 }
2616
2617 public void setInput(String input) {
2618 this.input = input;
2619 }
2620
2621 public String getInputEncoding() {
2622 return inputEncoding;
2623 }
2624
2625 public void setInputEncoding(String inputEncoding) {
2626 this.inputEncoding = inputEncoding;
2627 }
2628
2629 public String getFilePatterns() {
2630 return filePatterns;
2631 }
2632
2633 public void setFilePatterns(String filePatterns) {
2634 this.filePatterns = filePatterns;
2635 }
2636
2637 public boolean isRecursive() {
2638 return recursive;
2639 }
2640
2641 public void setRecursive(boolean recursive) {
2642 this.recursive = recursive;
2643 }
2644
2645 public String getExclude() {
2646 return exclude;
2647 }
2648
2649 public void setExclude(String exclude) {
2650 this.exclude = exclude;
2651 }
2652
2653 public boolean isExcludeSymlinks() {
2654 return excludeSymlinks;
2655 }
2656
2657 public void setExcludeSymlinks(boolean excludeSymlinks) {
2658 this.excludeSymlinks = excludeSymlinks;
2659 }
2660
2661 public String getExcludePatterns() {
2662 return excludePatterns;
2663 }
2664
2665 public void setExcludePatterns(String excludePatterns) {
2666 this.excludePatterns = excludePatterns;
2667 }
2668
2669 public String getExcludeSymbols() {
2670 return excludeSymbols;
2671 }
2672
2673 public void setExcludeSymbols(String excludeSymbols) {
2674 this.excludeSymbols = excludeSymbols;
2675 }
2676
2677 public String getExamplePath() {
2678 return examplePath;
2679 }
2680
2681 public void setExamplePath(String examplePath) {
2682 this.examplePath = examplePath;
2683 }
2684
2685 public String getExamplePatterns() {
2686 return examplePatterns;
2687 }
2688
2689 public void setExamplePatterns(String examplePatterns) {
2690 this.examplePatterns = examplePatterns;
2691 }
2692
2693 public boolean isExampleRecursive() {
2694 return exampleRecursive;
2695 }
2696
2697 public void setExampleRecursive(boolean exampleRecursive) {
2698 this.exampleRecursive = exampleRecursive;
2699 }
2700
2701 public String getImagePath() {
2702 return imagePath;
2703 }
2704
2705 public void setImagePath(String imagePath) {
2706 this.imagePath = imagePath;
2707 }
2708
2709 public String getInputFilter() {
2710 return inputFilter;
2711 }
2712
2713 public void setInputFilter(String inputFilter) {
2714 this.inputFilter = inputFilter;
2715 }
2716
2717 public String getFilterPatterns() {
2718 return filterPatterns;
2719 }
2720
2721 public void setFilterPatterns(String filterPatterns) {
2722 this.filterPatterns = filterPatterns;
2723 }
2724
2725 public boolean isFilterSourceFiles() {
2726 return filterSourceFiles;
2727 }
2728
2729 public void setFilterSourceFiles(boolean filterSourceFiles) {
2730 this.filterSourceFiles = filterSourceFiles;
2731 }
2732
2733 public boolean isSourceBrowser() {
2734 return sourceBrowser;
2735 }
2736
2737 public void setSourceBrowser(boolean sourceBrowser) {
2738 this.sourceBrowser = sourceBrowser;
2739 }
2740
2741 public boolean isInlineSources() {
2742 return inlineSources;
2743 }
2744
2745 public void setInlineSources(boolean inlineSources) {
2746 this.inlineSources = inlineSources;
2747 }
2748
2749 public boolean isStripCodeComments() {
2750 return stripCodeComments;
2751 }
2752
2753 public void setStripCodeComments(boolean stripCodeComments) {
2754 this.stripCodeComments = stripCodeComments;
2755 }
2756
2757 public boolean isReferencedByRelation() {
2758 return referencedByRelation;
2759 }
2760
2761 public void setReferencedByRelation(boolean referencedByRelation) {
2762 this.referencedByRelation = referencedByRelation;
2763 }
2764
2765 public boolean isReferencesRelation() {
2766 return referencesRelation;
2767 }
2768
2769 public void setReferencesRelation(boolean referencesRelation) {
2770 this.referencesRelation = referencesRelation;
2771 }
2772
2773 public boolean isReferencesLinkSource() {
2774 return referencesLinkSource;
2775 }
2776
2777 public void setReferencesLinkSource(boolean referencesLinkSource) {
2778 this.referencesLinkSource = referencesLinkSource;
2779 }
2780
2781 public boolean isUseHtags() {
2782 return useHtags;
2783 }
2784
2785 public void setUseHtags(boolean useHtags) {
2786 this.useHtags = useHtags;
2787 }
2788
2789 public boolean isVerbatimHeaders() {
2790 return verbatimHeaders;
2791 }
2792
2793 public void setVerbatimHeaders(boolean verbatimHeaders) {
2794 this.verbatimHeaders = verbatimHeaders;
2795 }
2796
2797 public boolean isAlphabeticalIndex() {
2798 return alphabeticalIndex;
2799 }
2800
2801 public void setAlphabeticalIndex(boolean alphabeticalIndex) {
2802 this.alphabeticalIndex = alphabeticalIndex;
2803 }
2804
2805 public Integer getColsInAlphaIndex() {
2806 return colsInAlphaIndex;
2807 }
2808
2809 public void setColsInAlphaIndex(Integer colsInAlphaIndex) {
2810 this.colsInAlphaIndex = colsInAlphaIndex;
2811 }
2812
2813 public String getIgnorePrefix() {
2814 return ignorePrefix;
2815 }
2816
2817 public void setIgnorePrefix(String ignorePrefix) {
2818 this.ignorePrefix = ignorePrefix;
2819 }
2820
2821 public boolean isGenerateHtml() {
2822 return generateHtml;
2823 }
2824
2825 public void setGenerateHtml(boolean generateHtml) {
2826 this.generateHtml = generateHtml;
2827 }
2828
2829 public String getHtmlOutput() {
2830 return htmlOutput;
2831 }
2832
2833 public void setHtmlOutput(String htmlOutput) {
2834 this.htmlOutput = htmlOutput;
2835 }
2836
2837 public String getHtmlFileExtension() {
2838 return htmlFileExtension;
2839 }
2840
2841 public void setHtmlFileExtension(String htmlFileExtension) {
2842 this.htmlFileExtension = htmlFileExtension;
2843 }
2844
2845 public String getHtmlHeader() {
2846 return htmlHeader;
2847 }
2848
2849 public void setHtmlHeader(String htmlHeader) {
2850 this.htmlHeader = htmlHeader;
2851 }
2852
2853 public String getHtmlFooter() {
2854 return htmlFooter;
2855 }
2856
2857 public void setHtmlFooter(String htmlFooter) {
2858 this.htmlFooter = htmlFooter;
2859 }
2860
2861 public String getHtmlStylesheet() {
2862 return htmlStylesheet;
2863 }
2864
2865 public void setHtmlStylesheet(String htmlStylesheet) {
2866 this.htmlStylesheet = htmlStylesheet;
2867 }
2868
2869 public boolean isHtmlAlignMembers() {
2870 return htmlAlignMembers;
2871 }
2872
2873 public void setHtmlAlignMembers(boolean htmlAlignMembers) {
2874 this.htmlAlignMembers = htmlAlignMembers;
2875 }
2876
2877 public boolean isHtmlDynamicSections() {
2878 return htmlDynamicSections;
2879 }
2880
2881 public void setHtmlDynamicSections(boolean htmlDynamicSections) {
2882 this.htmlDynamicSections = htmlDynamicSections;
2883 }
2884
2885 public boolean isGenerateDocset() {
2886 return generateDocset;
2887 }
2888
2889 public void setGenerateDocset(boolean generateDocset) {
2890 this.generateDocset = generateDocset;
2891 }
2892
2893 public String getDocsetFeedname() {
2894 return docsetFeedname;
2895 }
2896
2897 public void setDocsetFeedname(String docsetFeedname) {
2898 this.docsetFeedname = docsetFeedname;
2899 }
2900
2901 public String getDocsetBundleId() {
2902 return docsetBundleId;
2903 }
2904
2905 public void setDocsetBundleId(String docsetBundleId) {
2906 this.docsetBundleId = docsetBundleId;
2907 }
2908
2909 public boolean isGenerateHtmlhelp() {
2910 return generateHtmlhelp;
2911 }
2912
2913 public void setGenerateHtmlhelp(boolean generateHtmlhelp) {
2914 this.generateHtmlhelp = generateHtmlhelp;
2915 }
2916
2917 public String getChmFile() {
2918 return chmFile;
2919 }
2920
2921 public void setChmFile(String chmFile) {
2922 this.chmFile = chmFile;
2923 }
2924
2925 public String getHhcLocation() {
2926 return hhcLocation;
2927 }
2928
2929 public void setHhcLocation(String hhcLocation) {
2930 this.hhcLocation = hhcLocation;
2931 }
2932
2933 public boolean isGenerateChi() {
2934 return generateChi;
2935 }
2936
2937 public void setGenerateChi(boolean generateChi) {
2938 this.generateChi = generateChi;
2939 }
2940
2941 public String getChmIndexEncoding() {
2942 return chmIndexEncoding;
2943 }
2944
2945 public void setChmIndexEncoding(String chmIndexEncoding) {
2946 this.chmIndexEncoding = chmIndexEncoding;
2947 }
2948
2949 public boolean isBinaryToc() {
2950 return binaryToc;
2951 }
2952
2953 public void setBinaryToc(boolean binaryToc) {
2954 this.binaryToc = binaryToc;
2955 }
2956
2957 public boolean isTocExpand() {
2958 return tocExpand;
2959 }
2960
2961 public void setTocExpand(boolean tocExpand) {
2962 this.tocExpand = tocExpand;
2963 }
2964
2965 public boolean isGenerateQhp() {
2966 return generateQhp;
2967 }
2968
2969 public void setGenerateQhp(boolean generateQhp) {
2970 this.generateQhp = generateQhp;
2971 }
2972
2973 public String getQchFile() {
2974 return qchFile;
2975 }
2976
2977 public void setQchFile(String qchFile) {
2978 this.qchFile = qchFile;
2979 }
2980
2981 public String getQhpNamespace() {
2982 return qhpNamespace;
2983 }
2984
2985 public void setQhpNamespace(String qhpNamespace) {
2986 this.qhpNamespace = qhpNamespace;
2987 }
2988
2989 public String getQhpVirtualFolder() {
2990 return qhpVirtualFolder;
2991 }
2992
2993 public void setQhpVirtualFolder(String qhpVirtualFolder) {
2994 this.qhpVirtualFolder = qhpVirtualFolder;
2995 }
2996
2997 public String getQhgLocation() {
2998 return qhgLocation;
2999 }
3000
3001 public void setQhgLocation(String qhgLocation) {
3002 this.qhgLocation = qhgLocation;
3003 }
3004
3005 public boolean isDisableIndex() {
3006 return disableIndex;
3007 }
3008
3009 public void setDisableIndex(boolean disableIndex) {
3010 this.disableIndex = disableIndex;
3011 }
3012
3013 public Integer getEnumValuesPerLine() {
3014 return enumValuesPerLine;
3015 }
3016
3017 public void setEnumValuesPerLine(Integer enumValuesPerLine) {
3018 this.enumValuesPerLine = enumValuesPerLine;
3019 }
3020
3021 public String getGenerateTreeview() {
3022 return generateTreeview;
3023 }
3024
3025 public void setGenerateTreeview(String generateTreeview) {
3026 this.generateTreeview = generateTreeview;
3027 }
3028
3029 public Integer getTreeviewWidth() {
3030 return treeviewWidth;
3031 }
3032
3033 public void setTreeviewWidth(Integer treeviewWidth) {
3034 this.treeviewWidth = treeviewWidth;
3035 }
3036
3037 public Integer getFormulaFontsize() {
3038 return formulaFontsize;
3039 }
3040
3041 public void setFormulaFontsize(Integer formulaFontsize) {
3042 this.formulaFontsize = formulaFontsize;
3043 }
3044
3045 public boolean isGenerateLatex() {
3046 return generateLatex;
3047 }
3048
3049 public void setGenerateLatex(boolean generateLatex) {
3050 this.generateLatex = generateLatex;
3051 }
3052
3053 public String getLatexOutput() {
3054 return latexOutput;
3055 }
3056
3057 public void setLatexOutput(String latexOutput) {
3058 this.latexOutput = latexOutput;
3059 }
3060
3061 public String getLatexCmdName() {
3062 return latexCmdName;
3063 }
3064
3065 public void setLatexCmdName(String latexCmdName) {
3066 this.latexCmdName = latexCmdName;
3067 }
3068
3069 public String getMakeindexCmdName() {
3070 return makeindexCmdName;
3071 }
3072
3073 public void setMakeindexCmdName(String makeindexCmdName) {
3074 this.makeindexCmdName = makeindexCmdName;
3075 }
3076
3077 public boolean isCompactLatex() {
3078 return compactLatex;
3079 }
3080
3081 public void setCompactLatex(boolean compactLatex) {
3082 this.compactLatex = compactLatex;
3083 }
3084
3085 public String getPaperType() {
3086 return paperType;
3087 }
3088
3089 public void setPaperType(String paperType) {
3090 this.paperType = paperType;
3091 }
3092
3093 public String getExtraPackages() {
3094 return extraPackages;
3095 }
3096
3097 public void setExtraPackages(String extraPackages) {
3098 this.extraPackages = extraPackages;
3099 }
3100
3101 public String getLatexHeader() {
3102 return latexHeader;
3103 }
3104
3105 public void setLatexHeader(String latexHeader) {
3106 this.latexHeader = latexHeader;
3107 }
3108
3109 public boolean isPdfHyperlinks() {
3110 return pdfHyperlinks;
3111 }
3112
3113 public void setPdfHyperlinks(boolean pdfHyperlinks) {
3114 this.pdfHyperlinks = pdfHyperlinks;
3115 }
3116
3117 public boolean isUsePdflatex() {
3118 return usePdflatex;
3119 }
3120
3121 public void setUsePdflatex(boolean usePdflatex) {
3122 this.usePdflatex = usePdflatex;
3123 }
3124
3125 public boolean isLatexBatchmode() {
3126 return latexBatchmode;
3127 }
3128
3129 public void setLatexBatchmode(boolean latexBatchmode) {
3130 this.latexBatchmode = latexBatchmode;
3131 }
3132
3133 public boolean isLatexHideIndices() {
3134 return latexHideIndices;
3135 }
3136
3137 public void setLatexHideIndices(boolean latexHideIndices) {
3138 this.latexHideIndices = latexHideIndices;
3139 }
3140
3141 public boolean isGenerateRtf() {
3142 return generateRtf;
3143 }
3144
3145 public void setGenerateRtf(boolean generateRtf) {
3146 this.generateRtf = generateRtf;
3147 }
3148
3149 public String getRtfOutput() {
3150 return rtfOutput;
3151 }
3152
3153 public void setRtfOutput(String rtfOutput) {
3154 this.rtfOutput = rtfOutput;
3155 }
3156
3157 public boolean isCompactRtf() {
3158 return compactRtf;
3159 }
3160
3161 public void setCompactRtf(boolean compactRtf) {
3162 this.compactRtf = compactRtf;
3163 }
3164
3165 public boolean isRtfHyperlinks() {
3166 return rtfHyperlinks;
3167 }
3168
3169 public void setRtfHyperlinks(boolean rtfHyperlinks) {
3170 this.rtfHyperlinks = rtfHyperlinks;
3171 }
3172
3173 public String getRtfStylesheetFile() {
3174 return rtfStylesheetFile;
3175 }
3176
3177 public void setRtfStylesheetFile(String rtfStylesheetFile) {
3178 this.rtfStylesheetFile = rtfStylesheetFile;
3179 }
3180
3181 public String getRtfExtensionsFile() {
3182 return rtfExtensionsFile;
3183 }
3184
3185 public void setRtfExtensionsFile(String rtfExtensionsFile) {
3186 this.rtfExtensionsFile = rtfExtensionsFile;
3187 }
3188
3189 public boolean isGenerateMan() {
3190 return generateMan;
3191 }
3192
3193 public void setGenerateMan(boolean generateMan) {
3194 this.generateMan = generateMan;
3195 }
3196
3197 public String getManOutput() {
3198 return manOutput;
3199 }
3200
3201 public void setManOutput(String manOutput) {
3202 this.manOutput = manOutput;
3203 }
3204
3205 public String getManExtension() {
3206 return manExtension;
3207 }
3208
3209 public void setManExtension(String manExtension) {
3210 this.manExtension = manExtension;
3211 }
3212
3213 public boolean isManLinks() {
3214 return manLinks;
3215 }
3216
3217 public void setManLinks(boolean manLinks) {
3218 this.manLinks = manLinks;
3219 }
3220
3221 public boolean isGenerateXml() {
3222 return generateXml;
3223 }
3224
3225 public void setGenerateXml(boolean generateXml) {
3226 this.generateXml = generateXml;
3227 }
3228
3229 public String getXmlOutput() {
3230 return xmlOutput;
3231 }
3232
3233 public void setXmlOutput(String xmlOutput) {
3234 this.xmlOutput = xmlOutput;
3235 }
3236
3237 public String getXmlSchema() {
3238 return xmlSchema;
3239 }
3240
3241 public void setXmlSchema(String xmlSchema) {
3242 this.xmlSchema = xmlSchema;
3243 }
3244
3245 public String getXmlDtd() {
3246 return xmlDtd;
3247 }
3248
3249 public void setXmlDtd(String xmlDtd) {
3250 this.xmlDtd = xmlDtd;
3251 }
3252
3253 public boolean isXmlProgramlisting() {
3254 return xmlProgramlisting;
3255 }
3256
3257 public void setXmlProgramlisting(boolean xmlProgramlisting) {
3258 this.xmlProgramlisting = xmlProgramlisting;
3259 }
3260
3261 public boolean isGenerateAutogenDef() {
3262 return generateAutogenDef;
3263 }
3264
3265 public void setGenerateAutogenDef(boolean generateAutogenDef) {
3266 this.generateAutogenDef = generateAutogenDef;
3267 }
3268
3269 public boolean isGeneratePerlmod() {
3270 return generatePerlmod;
3271 }
3272
3273 public void setGeneratePerlmod(boolean generatePerlmod) {
3274 this.generatePerlmod = generatePerlmod;
3275 }
3276
3277 public boolean isPerlmodLatex() {
3278 return perlmodLatex;
3279 }
3280
3281 public void setPerlmodLatex(boolean perlmodLatex) {
3282 this.perlmodLatex = perlmodLatex;
3283 }
3284
3285 public boolean isPerlmodPretty() {
3286 return perlmodPretty;
3287 }
3288
3289 public void setPerlmodPretty(boolean perlmodPretty) {
3290 this.perlmodPretty = perlmodPretty;
3291 }
3292
3293 public String getPerlmodMakevarPrefix() {
3294 return perlmodMakevarPrefix;
3295 }
3296
3297 public void setPerlmodMakevarPrefix(String perlmodMakevarPrefix) {
3298 this.perlmodMakevarPrefix = perlmodMakevarPrefix;
3299 }
3300
3301 public boolean isEnablePreprocessing() {
3302 return enablePreprocessing;
3303 }
3304
3305 public void setEnablePreprocessing(boolean enablePreprocessing) {
3306 this.enablePreprocessing = enablePreprocessing;
3307 }
3308
3309 public boolean isMacroExpansion() {
3310 return macroExpansion;
3311 }
3312
3313 public void setMacroExpansion(boolean macroExpansion) {
3314 this.macroExpansion = macroExpansion;
3315 }
3316
3317 public boolean isExpandOnlyPredef() {
3318 return expandOnlyPredef;
3319 }
3320
3321 public void setExpandOnlyPredef(boolean expandOnlyPredef) {
3322 this.expandOnlyPredef = expandOnlyPredef;
3323 }
3324
3325 public boolean isSearchIncludes() {
3326 return searchIncludes;
3327 }
3328
3329 public void setSearchIncludes(boolean searchIncludes) {
3330 this.searchIncludes = searchIncludes;
3331 }
3332
3333 public String getIncludePath() {
3334 return includePath;
3335 }
3336
3337 public void setIncludePath(String includePath) {
3338 this.includePath = includePath;
3339 }
3340
3341 public String getIncludeFilePatterns() {
3342 return includeFilePatterns;
3343 }
3344
3345 public void setIncludeFilePatterns(String includeFilePatterns) {
3346 this.includeFilePatterns = includeFilePatterns;
3347 }
3348
3349 public String getPredefined() {
3350 return predefined;
3351 }
3352
3353 public void setPredefined(String predefined) {
3354 this.predefined = predefined;
3355 }
3356
3357 public String getExpandAsDefined() {
3358 return expandAsDefined;
3359 }
3360
3361 public void setExpandAsDefined(String expandAsDefined) {
3362 this.expandAsDefined = expandAsDefined;
3363 }
3364
3365 public boolean isSkipFunctionMacros() {
3366 return skipFunctionMacros;
3367 }
3368
3369 public void setSkipFunctionMacros(boolean skipFunctionMacros) {
3370 this.skipFunctionMacros = skipFunctionMacros;
3371 }
3372
3373 public String getTagfiles() {
3374 return tagfiles;
3375 }
3376
3377 public void setTagfiles(String tagfiles) {
3378 this.tagfiles = tagfiles;
3379 }
3380
3381 public String getGenerateTagfile() {
3382 return generateTagfile;
3383 }
3384
3385 public void setGenerateTagfile(String generateTagfile) {
3386 this.generateTagfile = generateTagfile;
3387 }
3388
3389 public boolean isAllexternals() {
3390 return allexternals;
3391 }
3392
3393 public void setAllexternals(boolean allexternals) {
3394 this.allexternals = allexternals;
3395 }
3396
3397 public boolean isExternalGroups() {
3398 return externalGroups;
3399 }
3400
3401 public void setExternalGroups(boolean externalGroups) {
3402 this.externalGroups = externalGroups;
3403 }
3404
3405 public String getPerlPath() {
3406 return perlPath;
3407 }
3408
3409 public void setPerlPath(String perlPath) {
3410 this.perlPath = perlPath;
3411 }
3412
3413 public boolean isClassDiagrams() {
3414 return classDiagrams;
3415 }
3416
3417 public void setClassDiagrams(boolean classDiagrams) {
3418 this.classDiagrams = classDiagrams;
3419 }
3420
3421 public String getMscgenPath() {
3422 return mscgenPath;
3423 }
3424
3425 public void setMscgenPath(String mscgenPath) {
3426 this.mscgenPath = mscgenPath;
3427 }
3428
3429 public boolean isHideUndocRelations() {
3430 return hideUndocRelations;
3431 }
3432
3433 public void setHideUndocRelations(boolean hideUndocRelations) {
3434 this.hideUndocRelations = hideUndocRelations;
3435 }
3436
3437 public boolean isHaveDot() {
3438 return haveDot;
3439 }
3440
3441 public void setHaveDot(boolean haveDot) {
3442 this.haveDot = haveDot;
3443 }
3444
3445 public String getDotFontname() {
3446 return dotFontname;
3447 }
3448
3449 public void setDotFontname(String dotFontname) {
3450 this.dotFontname = dotFontname;
3451 }
3452
3453 public Integer getDotFontsize() {
3454 return dotFontsize;
3455 }
3456
3457 public void setDotFontsize(Integer dotFontsize) {
3458 this.dotFontsize = dotFontsize;
3459 }
3460
3461 public String getDotFontpath() {
3462 return dotFontpath;
3463 }
3464
3465 public void setDotFontpath(String dotFontpath) {
3466 this.dotFontpath = dotFontpath;
3467 }
3468
3469 public boolean isClassGraph() {
3470 return classGraph;
3471 }
3472
3473 public void setClassGraph(boolean classGraph) {
3474 this.classGraph = classGraph;
3475 }
3476
3477 public boolean isCollaborationGraph() {
3478 return collaborationGraph;
3479 }
3480
3481 public void setCollaborationGraph(boolean collaborationGraph) {
3482 this.collaborationGraph = collaborationGraph;
3483 }
3484
3485 public boolean isGroupGraphs() {
3486 return groupGraphs;
3487 }
3488
3489 public void setGroupGraphs(boolean groupGraphs) {
3490 this.groupGraphs = groupGraphs;
3491 }
3492
3493 public boolean isUmlLook() {
3494 return umlLook;
3495 }
3496
3497 public void setUmlLook(boolean umlLook) {
3498 this.umlLook = umlLook;
3499 }
3500
3501 public boolean isTemplateRelations() {
3502 return templateRelations;
3503 }
3504
3505 public void setTemplateRelations(boolean templateRelations) {
3506 this.templateRelations = templateRelations;
3507 }
3508
3509 public boolean isIncludeGraph() {
3510 return includeGraph;
3511 }
3512
3513 public void setIncludeGraph(boolean includeGraph) {
3514 this.includeGraph = includeGraph;
3515 }
3516
3517 public boolean isIncludedByGraph() {
3518 return includedByGraph;
3519 }
3520
3521 public void setIncludedByGraph(boolean includedByGraph) {
3522 this.includedByGraph = includedByGraph;
3523 }
3524
3525 public boolean isCallGraph() {
3526 return callGraph;
3527 }
3528
3529 public void setCallGraph(boolean callGraph) {
3530 this.callGraph = callGraph;
3531 }
3532
3533 public boolean isCallerGraph() {
3534 return callerGraph;
3535 }
3536
3537 public void setCallerGraph(boolean callerGraph) {
3538 this.callerGraph = callerGraph;
3539 }
3540
3541 public boolean isGraphicalHierarchy() {
3542 return graphicalHierarchy;
3543 }
3544
3545 public void setGraphicalHierarchy(boolean graphicalHierarchy) {
3546 this.graphicalHierarchy = graphicalHierarchy;
3547 }
3548
3549 public boolean isDirectoryGraph() {
3550 return directoryGraph;
3551 }
3552
3553 public void setDirectoryGraph(boolean directoryGraph) {
3554 this.directoryGraph = directoryGraph;
3555 }
3556
3557 public String getDotImageFormat() {
3558 return dotImageFormat;
3559 }
3560
3561 public void setDotImageFormat(String dotImageFormat) {
3562 this.dotImageFormat = dotImageFormat;
3563 }
3564
3565 public String getDotPath() {
3566 return dotPath;
3567 }
3568
3569 public void setDotPath(String dotPath) {
3570 this.dotPath = dotPath;
3571 }
3572
3573 public String getDotfileDirs() {
3574 return dotfileDirs;
3575 }
3576
3577 public void setDotfileDirs(String dotfileDirs) {
3578 this.dotfileDirs = dotfileDirs;
3579 }
3580
3581 public Integer getDotGraphMaxNodes() {
3582 return dotGraphMaxNodes;
3583 }
3584
3585 public void setDotGraphMaxNodes(Integer dotGraphMaxNodes) {
3586 this.dotGraphMaxNodes = dotGraphMaxNodes;
3587 }
3588
3589 public Integer getMaxDotGraphDepth() {
3590 return maxDotGraphDepth;
3591 }
3592
3593 public void setMaxDotGraphDepth(Integer maxDotGraphDepth) {
3594 this.maxDotGraphDepth = maxDotGraphDepth;
3595 }
3596
3597 public boolean isDotTransparent() {
3598 return dotTransparent;
3599 }
3600
3601 public void setDotTransparent(boolean dotTransparent) {
3602 this.dotTransparent = dotTransparent;
3603 }
3604
3605 public boolean isDotMultiTargets() {
3606 return dotMultiTargets;
3607 }
3608
3609 public void setDotMultiTargets(boolean dotMultiTargets) {
3610 this.dotMultiTargets = dotMultiTargets;
3611 }
3612
3613 public boolean isGenerateLegend() {
3614 return generateLegend;
3615 }
3616
3617 public void setGenerateLegend(boolean generateLegend) {
3618 this.generateLegend = generateLegend;
3619 }
3620
3621 public boolean isDotCleanup() {
3622 return dotCleanup;
3623 }
3624
3625 public void setDotCleanup(boolean dotCleanup) {
3626 this.dotCleanup = dotCleanup;
3627 }
3628
3629 public boolean isSearchengine() {
3630 return searchengine;
3631 }
3632
3633 public void setSearchengine(boolean searchengine) {
3634 this.searchengine = searchengine;
3635 }
3636
3637 }