Skip to content

Commit 358c638

Browse files
committedOct 7, 2012
doxygen update:
- include core/diagram and gui/symbology-ng - enable dynamic sections
1 parent 409d695 commit 358c638

File tree

1 file changed

+263
-99
lines changed

1 file changed

+263
-99
lines changed
 

‎Doxyfile

Lines changed: 263 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Doxyfile 1.7.1
1+
# Doxyfile 1.8.1.2
22

33
# This file describes the settings to be used by the documentation system
4-
# doxygen (www.doxygen.org) for a project
4+
# doxygen (www.doxygen.org) for a project.
55
#
6-
# All text after a hash (#) is considered a comment and will be ignored
6+
# All text after a hash (#) is considered a comment and will be ignored.
77
# The format is:
88
# TAG = value [value, ...]
99
# For lists items can also be appended using:
1010
# TAG += value [value, ...]
11-
# Values that contain spaces should be placed between quotes (" ")
11+
# Values that contain spaces should be placed between quotes (" ").
1212

1313
#---------------------------------------------------------------------------
1414
# Project related configuration options
@@ -22,8 +22,9 @@
2222

2323
DOXYFILE_ENCODING = UTF-8
2424

25-
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26-
# by quotes) that should identify the project.
25+
# The PROJECT_NAME tag is a single word (or sequence of words) that should
26+
# identify the project. Note that if you do not use Doxywizard you need
27+
# to put quotes around the project name if it contains spaces.
2728

2829
PROJECT_NAME = "Quantum GIS API Documentation"
2930

@@ -33,6 +34,19 @@ PROJECT_NAME = "Quantum GIS API Documentation"
3334

3435
PROJECT_NUMBER = HEAD-r10124
3536

37+
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38+
# for a project that appears at the top of each page and should give viewer
39+
# a quick idea about the purpose of the project. Keep the description short.
40+
41+
PROJECT_BRIEF =
42+
43+
# With the PROJECT_LOGO tag one can specify an logo or icon that is
44+
# included in the documentation. The maximum height of the logo should not
45+
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46+
# Doxygen will copy the logo to the output directory.
47+
48+
PROJECT_LOGO =
49+
3650
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
3751
# base path where the generated documentation will be put.
3852
# If a relative path is entered, it will be relative to the location
@@ -57,7 +71,7 @@ CREATE_SUBDIRS = NO
5771
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
5872
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
5973
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60-
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
74+
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
6175
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
6276

6377
OUTPUT_LANGUAGE = English
@@ -136,7 +150,7 @@ STRIP_FROM_PATH =
136150
STRIP_FROM_INC_PATH =
137151

138152
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139-
# (but less readable) file names. This can be useful is your file systems
153+
# (but less readable) file names. This can be useful if your file system
140154
# doesn't support long names like on DOS, Mac, or CD-ROM.
141155

142156
SHORT_NAMES = NO
@@ -191,6 +205,13 @@ TAB_SIZE = 2
191205

192206
ALIASES =
193207

208+
# This tag can be used to specify a number of word-keyword mappings (TCL only).
209+
# A mapping has the form "name=value". For example adding
210+
# "class=itcl::class" will allow you to use the command class in the
211+
# itcl::class meaning.
212+
213+
TCL_SUBST =
214+
194215
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195216
# sources only. Doxygen will then generate output that is more tailored for C.
196217
# For instance, some of the names that are used will be different. The list
@@ -229,11 +250,20 @@ OPTIMIZE_OUTPUT_VHDL = NO
229250

230251
EXTENSION_MAPPING =
231252

253+
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
254+
# comments according to the Markdown format, which allows for more readable
255+
# documentation. See http://daringfireball.net/projects/markdown/ for details.
256+
# The output of markdown processing is further processed by doxygen, so you
257+
# can mix doxygen, HTML, and XML commands with Markdown formatting.
258+
# Disable only in case of backward compatibilities issues.
259+
260+
MARKDOWN_SUPPORT = YES
261+
232262
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233263
# to include (a tag file for) the STL sources as input, then you should
234264
# set this tag to YES in order to let doxygen match functions declarations and
235265
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236-
# func(std::string) {}). This also make the inheritance and collaboration
266+
# func(std::string) {}). This also makes the inheritance and collaboration
237267
# diagrams that involve STL classes more complete and accurate.
238268

239269
BUILTIN_STL_SUPPORT = NO
@@ -251,7 +281,7 @@ SIP_SUPPORT = YES
251281

252282
# For Microsoft's IDL there are propget and propput attributes to indicate getter
253283
# and setter methods for a property. Setting this option to YES (the default)
254-
# will make doxygen to replace the get and set methods by a property in the
284+
# will make doxygen replace the get and set methods by a property in the
255285
# documentation. This will only work if the methods are indeed getting or
256286
# setting a simple type. If this is not the case, or you want to show the
257287
# methods anyway, you should set this option to NO.
@@ -273,6 +303,22 @@ DISTRIBUTE_GROUP_DOC = NO
273303

274304
SUBGROUPING = YES
275305

306+
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
307+
# unions are shown inside the group in which they are included (e.g. using
308+
# @ingroup) instead of on a separate page (for HTML and Man pages) or
309+
# section (for LaTeX and RTF).
310+
311+
INLINE_GROUPED_CLASSES = NO
312+
313+
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
314+
# unions with only public data fields will be shown inline in the documentation
315+
# of the scope in which they are defined (i.e. file, namespace, or group
316+
# documentation), provided this scope is documented. If set to NO (the default),
317+
# structs, classes, and unions are shown on a separate page (for HTML and Man
318+
# pages) or section (for LaTeX and RTF).
319+
320+
INLINE_SIMPLE_STRUCTS = NO
321+
276322
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277323
# is documented as struct, union, or enum with the name of the typedef. So
278324
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
@@ -289,16 +335,27 @@ TYPEDEF_HIDES_STRUCT = NO
289335
# For small to medium size projects (<1000 input files) the default value is
290336
# probably good enough. For larger projects a too small cache size can cause
291337
# doxygen to be busy swapping symbols to and from disk most of the time
292-
# causing a significant performance penality.
338+
# causing a significant performance penalty.
293339
# If the system has enough physical memory increasing the cache will improve the
294340
# performance by keeping more symbols in memory. Note that the value works on
295-
# a logarithmic scale so increasing the size by one will rougly double the
341+
# a logarithmic scale so increasing the size by one will roughly double the
296342
# memory usage. The cache size is given by this formula:
297343
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298-
# corresponding to a cache size of 2^16 = 65536 symbols
344+
# corresponding to a cache size of 2^16 = 65536 symbols.
299345

300346
SYMBOL_CACHE_SIZE = 0
301347

348+
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
349+
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
350+
# their name and scope. Since this can be an expensive process and often the
351+
# same symbol appear multiple times in the code, doxygen keeps a cache of
352+
# pre-resolved symbols. If the cache is too small doxygen will become slower.
353+
# If the cache is too large, memory is wasted. The cache size is given by this
354+
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
355+
# corresponding to a cache size of 2^16 = 65536 symbols.
356+
357+
LOOKUP_CACHE_SIZE = 0
358+
302359
#---------------------------------------------------------------------------
303360
# Build related configuration options
304361
#---------------------------------------------------------------------------
@@ -315,6 +372,10 @@ EXTRACT_ALL = YES
315372

316373
EXTRACT_PRIVATE = YES
317374

375+
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
376+
377+
EXTRACT_PACKAGE = NO
378+
318379
# If the EXTRACT_STATIC tag is set to YES all static members of a file
319380
# will be included in the documentation.
320381

@@ -337,7 +398,7 @@ EXTRACT_LOCAL_METHODS = NO
337398
# extracted and appear in the documentation as a namespace called
338399
# 'anonymous_namespace{file}', where file will be replaced with the base
339400
# name of the file that contains the anonymous namespace. By default
340-
# anonymous namespace are hidden.
401+
# anonymous namespaces are hidden.
341402

342403
EXTRACT_ANON_NSPACES = NO
343404

@@ -420,7 +481,7 @@ SORT_MEMBER_DOCS = YES
420481
# by member name. If set to NO (the default) the members will appear in
421482
# declaration order.
422483

423-
SORT_BRIEF_DOCS = NO
484+
SORT_BRIEF_DOCS = YES
424485

425486
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426487
# will sort the (brief and detailed) documentation of class members so that
@@ -430,7 +491,7 @@ SORT_BRIEF_DOCS = NO
430491
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431492
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432493

433-
SORT_MEMBERS_CTORS_1ST = NO
494+
SORT_MEMBERS_CTORS_1ST = YES
434495

435496
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436497
# hierarchy of group names into alphabetical order. If set to NO (the default)
@@ -448,6 +509,15 @@ SORT_GROUP_NAMES = NO
448509

449510
SORT_BY_SCOPE_NAME = NO
450511

512+
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
513+
# do proper type resolution of all parameters of a function it will reject a
514+
# match between the prototype and the implementation of a member function even
515+
# if there is only one candidate or it is obvious which candidate to choose
516+
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
517+
# will still accept a match between prototype and implementation in such cases.
518+
519+
STRICT_PROTO_MATCHING = NO
520+
451521
# The GENERATE_TODOLIST tag can be used to enable (YES) or
452522
# disable (NO) the todo list. This list is created by putting \todo
453523
# commands in the documentation.
@@ -478,10 +548,10 @@ GENERATE_DEPRECATEDLIST= YES
478548
ENABLED_SECTIONS =
479549

480550
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481-
# the initial value of a variable or define consists of for it to appear in
551+
# the initial value of a variable or macro consists of for it to appear in
482552
# the documentation. If the initializer consists of more lines than specified
483553
# here it will be hidden. Use a value of 0 to hide initializers completely.
484-
# The appearance of the initializer of individual variables and defines in the
554+
# The appearance of the initializer of individual variables and macros in the
485555
# documentation can be controlled using \showinitializer or \hideinitializer
486556
# command in the documentation regardless of this setting.
487557

@@ -493,12 +563,6 @@ MAX_INITIALIZER_LINES = 30
493563

494564
SHOW_USED_FILES = YES
495565

496-
# If the sources in your project are distributed over multiple directories
497-
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498-
# in the documentation. The default is NO.
499-
500-
SHOW_DIRECTORIES = NO
501-
502566
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503567
# This will remove the Files entry from the Quick Index and from the
504568
# Folder Tree View (if specified). The default is YES.
@@ -524,13 +588,23 @@ FILE_VERSION_FILTER =
524588

525589
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
526590
# by doxygen. The layout file controls the global structure of the generated
527-
# output files in an output format independent way. The create the layout file
591+
# output files in an output format independent way. To create the layout file
528592
# that represents doxygen's defaults, run doxygen with the -l option.
529593
# You can optionally specify a file name after the option, if omitted
530594
# DoxygenLayout.xml will be used as the name of the layout file.
531595

532596
LAYOUT_FILE =
533597

598+
# The CITE_BIB_FILES tag can be used to specify one or more bib files
599+
# containing the references data. This must be a list of .bib files. The
600+
# .bib extension is automatically appended if omitted. Using this command
601+
# requires the bibtex tool to be installed. See also
602+
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
603+
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
604+
# feature you need bibtex and perl available in the search path.
605+
606+
CITE_BIB_FILES =
607+
534608
#---------------------------------------------------------------------------
535609
# configuration options related to warning and progress messages
536610
#---------------------------------------------------------------------------
@@ -559,7 +633,7 @@ WARN_IF_UNDOCUMENTED = YES
559633

560634
WARN_IF_DOC_ERROR = YES
561635

562-
# This WARN_NO_PARAMDOC option can be abled to get warnings for
636+
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
563637
# functions that are documented, but have no documentation for their parameters
564638
# or return value. If set to NO (the default) doxygen will only warn about
565639
# wrong or incomplete parameter documentation, but not about the absence of
@@ -593,6 +667,7 @@ WARN_LOGFILE =
593667

594668
INPUT = doc \
595669
src/core \
670+
src/core/diagram \
596671
src/core/composer \
597672
src/core/raster \
598673
src/core/renderer \
@@ -602,6 +677,7 @@ INPUT = doc \
602677
src/gui \
603678
src/gui/attributetable \
604679
src/gui/raster \
680+
src/gui/symbology-ng \
605681
src/analysis/interpolation \
606682
src/analysis/raster \
607683
src/analysis/vector \
@@ -620,8 +696,9 @@ INPUT_ENCODING = UTF-8
620696
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
621697
# and *.h) to filter out the source-files in the directories. If left
622698
# blank the following patterns are tested:
623-
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
624-
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
699+
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
700+
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
701+
# *.f90 *.f *.for *.vhd *.vhdl
625702

626703
FILE_PATTERNS = *.h \
627704
*.cpp \
@@ -633,14 +710,16 @@ FILE_PATTERNS = *.h \
633710

634711
RECURSIVE = NO
635712

636-
# The EXCLUDE tag can be used to specify files and/or directories that should
713+
# The EXCLUDE tag can be used to specify files and/or directories that should be
637714
# excluded from the INPUT source files. This way you can easily exclude a
638715
# subdirectory from a directory tree whose root is specified with the INPUT tag.
716+
# Note that relative paths are relative to the directory from which doxygen is
717+
# run.
639718

640719
EXCLUDE =
641720

642-
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
643-
# directories that are symbolic links (a Unix filesystem feature) are excluded
721+
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
722+
# directories that are symbolic links (a Unix file system feature) are excluded
644723
# from the input.
645724

646725
EXCLUDE_SYMLINKS = NO
@@ -707,8 +786,8 @@ INPUT_FILTER =
707786
# filter if there is a match.
708787
# The filters are a list of the form:
709788
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
710-
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
711-
# is applied to all files.
789+
# info on how filters are used. If FILTER_PATTERNS is empty or if
790+
# non of the patterns match the file name, INPUT_FILTER is applied.
712791

713792
FILTER_PATTERNS =
714793

@@ -718,6 +797,14 @@ FILTER_PATTERNS =
718797

719798
FILTER_SOURCE_FILES = NO
720799

800+
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
801+
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
802+
# and it is also possible to disable source filtering for a specific pattern
803+
# using *.ext= (so without naming a filter). This option only has effect when
804+
# FILTER_SOURCE_FILES is enabled.
805+
806+
FILTER_SOURCE_PATTERNS =
807+
721808
#---------------------------------------------------------------------------
722809
# configuration options related to source browsing
723810
#---------------------------------------------------------------------------
@@ -736,7 +823,7 @@ INLINE_SOURCES = NO
736823

737824
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
738825
# doxygen to hide any special comment blocks from generated source code
739-
# fragments. Normal C and C++ comments will always remain visible.
826+
# fragments. Normal C, C++ and Fortran comments will always remain visible.
740827

741828
STRIP_CODE_COMMENTS = YES
742829

@@ -820,7 +907,14 @@ HTML_FILE_EXTENSION = .html
820907

821908
# The HTML_HEADER tag can be used to specify a personal HTML header for
822909
# each generated HTML page. If it is left blank doxygen will generate a
823-
# standard header.
910+
# standard header. Note that when using a custom header you are responsible
911+
# for the proper inclusion of any scripts and style sheets that doxygen
912+
# needs, which is dependent on the configuration options used.
913+
# It is advised to generate a default header using "doxygen -w html
914+
# header.html footer.html stylesheet.css YourConfigFile" and then modify
915+
# that header. Note that the header is subject to change so you typically
916+
# have to redo this when upgrading to a newer version of doxygen or when
917+
# changing the value of configuration settings such as GENERATE_TREEVIEW!
824918

825919
HTML_HEADER =
826920

@@ -835,12 +929,21 @@ HTML_FOOTER =
835929
# fine-tune the look of the HTML output. If the tag is left blank doxygen
836930
# will generate a default style sheet. Note that doxygen will try to copy
837931
# the style sheet file to the HTML output directory, so don't put your own
838-
# stylesheet in the HTML output directory as well, or it will be erased!
932+
# style sheet in the HTML output directory as well, or it will be erased!
839933

840934
HTML_STYLESHEET =
841935

936+
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
937+
# other source files which should be copied to the HTML output directory. Note
938+
# that these files will be copied to the base HTML output directory. Use the
939+
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
940+
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
941+
# the files will be copied as-is; there are no commands or markers available.
942+
943+
HTML_EXTRA_FILES =
944+
842945
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
843-
# Doxygen will adjust the colors in the stylesheet and background images
946+
# Doxygen will adjust the colors in the style sheet and background images
844947
# according to this color. Hue is specified as an angle on a colorwheel,
845948
# see http://en.wikipedia.org/wiki/Hue for more information.
846949
# For instance the value 0 represents red, 60 is yellow, 120 is green,
@@ -870,19 +973,22 @@ HTML_COLORSTYLE_GAMMA = 80
870973

871974
HTML_TIMESTAMP = YES
872975

873-
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
874-
# files or namespaces will be aligned in HTML using tables. If set to
875-
# NO a bullet list will be used.
876-
877-
HTML_ALIGN_MEMBERS = YES
878-
879976
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
880977
# documentation will contain sections that can be hidden and shown after the
881-
# page has loaded. For this to work a browser that supports
882-
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
883-
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
978+
# page has loaded.
979+
980+
HTML_DYNAMIC_SECTIONS = YES
884981

885-
HTML_DYNAMIC_SECTIONS = NO
982+
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
983+
# entries shown in the various tree structured indices initially; the user
984+
# can expand and collapse entries dynamically later on. Doxygen will expand
985+
# the tree to such a level that at most the specified number of entries are
986+
# visible (unless a fully collapsed tree already exceeds this amount).
987+
# So setting the number of entries 1 will produce a full collapsed tree by
988+
# default. 0 is a special value representing an infinite number of entries
989+
# and will result in a full expanded tree by default.
990+
991+
HTML_INDEX_NUM_ENTRIES = 100
886992

887993
# If the GENERATE_DOCSET tag is set to YES, additional index files
888994
# will be generated that can be used as input for Apple's Xcode 3
@@ -1035,31 +1141,32 @@ GENERATE_ECLIPSEHELP = NO
10351141

10361142
ECLIPSE_DOC_ID = org.doxygen.Project
10371143

1038-
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1039-
# top of each HTML page. The value NO (the default) enables the index and
1040-
# the value YES disables it.
1144+
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1145+
# at top of each HTML page. The value NO (the default) enables the index and
1146+
# the value YES disables it. Since the tabs have the same information as the
1147+
# navigation tree you can set this option to NO if you already set
1148+
# GENERATE_TREEVIEW to YES.
10411149

10421150
DISABLE_INDEX = NO
10431151

1044-
# This tag can be used to set the number of enum values (range [1..20])
1045-
# that doxygen will group on one line in the generated HTML documentation.
1046-
1047-
ENUM_VALUES_PER_LINE = 4
1048-
10491152
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
10501153
# structure should be generated to display hierarchical information.
10511154
# If the tag value is set to YES, a side panel will be generated
10521155
# containing a tree-like index structure (just like the one that
10531156
# is generated for HTML Help). For this to work a browser that supports
10541157
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
10551158
# Windows users are probably better off using the HTML help feature.
1159+
# Since the tree basically has the same information as the tab index you
1160+
# could consider to set DISABLE_INDEX to NO when enabling this option.
10561161

1057-
GENERATE_TREEVIEW = NO
1162+
GENERATE_TREEVIEW = YES
10581163

1059-
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1060-
# and Class Hierarchy pages using a tree view instead of an ordered list.
1164+
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1165+
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1166+
# documentation. Note that a value of 0 will completely suppress the enum
1167+
# values from appearing in the overview section.
10611168

1062-
USE_INLINE_TREES = NO
1169+
ENUM_VALUES_PER_LINE = 4
10631170

10641171
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
10651172
# used to set the initial width (in pixels) of the frame in which the tree
@@ -1088,6 +1195,32 @@ FORMULA_FONTSIZE = 10
10881195

10891196
FORMULA_TRANSPARENT = YES
10901197

1198+
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1199+
# (see http://www.mathjax.org) which uses client side Javascript for the
1200+
# rendering instead of using prerendered bitmaps. Use this if you do not
1201+
# have LaTeX installed or if you want to formulas look prettier in the HTML
1202+
# output. When enabled you may also need to install MathJax separately and
1203+
# configure the path to it using the MATHJAX_RELPATH option.
1204+
1205+
USE_MATHJAX = NO
1206+
1207+
# When MathJax is enabled you need to specify the location relative to the
1208+
# HTML output directory using the MATHJAX_RELPATH option. The destination
1209+
# directory should contain the MathJax.js script. For instance, if the mathjax
1210+
# directory is located at the same level as the HTML output directory, then
1211+
# MATHJAX_RELPATH should be ../mathjax. The default value points to
1212+
# the MathJax Content Delivery Network so you can quickly see the result without
1213+
# installing MathJax.
1214+
# However, it is strongly recommended to install a local
1215+
# copy of MathJax from http://www.mathjax.org before deployment.
1216+
1217+
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1218+
1219+
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1220+
# names that should be enabled during MathJax rendering.
1221+
1222+
MATHJAX_EXTENSIONS =
1223+
10911224
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
10921225
# for the HTML output. The underlying search engine uses javascript
10931226
# and DHTML and should work on any modern browser. Note that when using
@@ -1103,7 +1236,7 @@ SEARCHENGINE = YES
11031236
# using Javascript. Doxygen will generate the search PHP script and index
11041237
# file to put on the web server. The advantage of the server
11051238
# based approach is that it scales better to large projects and allows
1106-
# full text search. The disadvances is that it is more difficult to setup
1239+
# full text search. The disadvantages are that it is more difficult to setup
11071240
# and does not have live searching capabilities.
11081241

11091242
SERVER_BASED_SEARCH = NO
@@ -1144,7 +1277,7 @@ MAKEINDEX_CMD_NAME = makeindex
11441277
COMPACT_LATEX = NO
11451278

11461279
# The PAPER_TYPE tag can be used to set the paper type that is used
1147-
# by the printer. Possible values are: a4, a4wide, letter, legal and
1280+
# by the printer. Possible values are: a4, letter, legal and
11481281
# executive. If left blank a4wide will be used.
11491282

11501283
PAPER_TYPE = a4wide
@@ -1161,6 +1294,13 @@ EXTRA_PACKAGES =
11611294

11621295
LATEX_HEADER =
11631296

1297+
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1298+
# the generated latex document. The footer should contain everything after
1299+
# the last chapter. If it is left blank doxygen will generate a
1300+
# standard footer. Notice: only use this tag if you know what you are doing!
1301+
1302+
LATEX_FOOTER =
1303+
11641304
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
11651305
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
11661306
# contain links (just like the HTML output) instead of page references
@@ -1194,6 +1334,12 @@ LATEX_HIDE_INDICES = NO
11941334

11951335
LATEX_SOURCE_CODE = NO
11961336

1337+
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1338+
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1339+
# http://en.wikipedia.org/wiki/BibTeX for more info.
1340+
1341+
LATEX_BIB_STYLE = plain
1342+
11971343
#---------------------------------------------------------------------------
11981344
# configuration options related to the RTF output
11991345
#---------------------------------------------------------------------------
@@ -1225,7 +1371,7 @@ COMPACT_RTF = NO
12251371

12261372
RTF_HYPERLINKS = NO
12271373

1228-
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1374+
# Load style sheet definitions from file. Syntax is similar to doxygen's
12291375
# config file, i.e. a series of assignments. You only have to provide
12301376
# replacements, missing definitions are set to their default value.
12311377

@@ -1370,7 +1516,7 @@ MACRO_EXPANSION = NO
13701516
EXPAND_ONLY_PREDEF = NO
13711517

13721518
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1373-
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1519+
# pointed to by INCLUDE_PATH will be searched when a #include is found.
13741520

13751521
SEARCH_INCLUDES = YES
13761522

@@ -1400,38 +1546,34 @@ PREDEFINED =
14001546
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
14011547
# this tag can be used to specify a list of macro names that should be expanded.
14021548
# The macro definition that is found in the sources will be used.
1403-
# Use the PREDEFINED tag if you want to use a different macro definition.
1549+
# Use the PREDEFINED tag if you want to use a different macro definition that
1550+
# overrules the definition found in the source code.
14041551

14051552
EXPAND_AS_DEFINED =
14061553

14071554
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1408-
# doxygen's preprocessor will remove all function-like macros that are alone
1409-
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1410-
# function macros are typically used for boiler-plate code, and will confuse
1411-
# the parser if not removed.
1555+
# doxygen's preprocessor will remove all references to function-like macros
1556+
# that are alone on a line, have an all uppercase name, and do not end with a
1557+
# semicolon, because these will confuse the parser if not removed.
14121558

14131559
SKIP_FUNCTION_MACROS = YES
14141560

14151561
#---------------------------------------------------------------------------
14161562
# Configuration::additions related to external references
14171563
#---------------------------------------------------------------------------
14181564

1419-
# The TAGFILES option can be used to specify one or more tagfiles.
1420-
# Optionally an initial location of the external documentation
1421-
# can be added for each tagfile. The format of a tag file without
1422-
# this location is as follows:
1565+
# The TAGFILES option can be used to specify one or more tagfiles. For each
1566+
# tag file the location of the external documentation should be added. The
1567+
# format of a tag file without this location is as follows:
14231568
#
14241569
# TAGFILES = file1 file2 ...
14251570
# Adding location for the tag files is done as follows:
14261571
#
14271572
# TAGFILES = file1=loc1 "file2 = loc2" ...
1428-
# where "loc1" and "loc2" can be relative or absolute paths or
1429-
# URLs. If a location is present for each tag, the installdox tool
1430-
# does not have to be run to correct the links.
1431-
# Note that each tag file must have a unique name
1432-
# (where the name does NOT include the path)
1433-
# If a tag file is not located in the directory in which doxygen
1434-
# is run, you must also specify the path to the tagfile here.
1573+
# where "loc1" and "loc2" can be relative or absolute paths
1574+
# or URLs. Note that each tag file must have a unique name (where the name does
1575+
# NOT include the path). If a tag file is not located in the directory in which
1576+
# doxygen is run, you must also specify the path to the tagfile here.
14351577

14361578
TAGFILES =
14371579

@@ -1464,9 +1606,8 @@ PERL_PATH = /usr/bin/perl
14641606
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
14651607
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
14661608
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1467-
# this option is superseded by the HAVE_DOT option below. This is only a
1468-
# fallback. It is recommended to install and use dot, since it yields more
1469-
# powerful graphs.
1609+
# this option also works with HAVE_DOT disabled, but it is recommended to
1610+
# install and use dot, since it yields more powerful graphs.
14701611

14711612
CLASS_DIAGRAMS = YES
14721613

@@ -1500,14 +1641,12 @@ HAVE_DOT = YES
15001641

15011642
DOT_NUM_THREADS = 0
15021643

1503-
# By default doxygen will write a font called FreeSans.ttf to the output
1504-
# directory and reference it in all dot files that doxygen generates. This
1505-
# font does not include all possible unicode characters however, so when you need
1506-
# these (or just want a differently looking font) you can specify the font name
1507-
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1508-
# which can be done by putting it in a standard location or by setting the
1509-
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1510-
# containing the font.
1644+
# By default doxygen will use the Helvetica font for all dot files that
1645+
# doxygen generates. When you want a differently looking font you can specify
1646+
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1647+
# the font, which can be done by putting it in a standard location or by setting
1648+
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1649+
# directory containing the font.
15111650

15121651
DOT_FONTNAME = FreeSans.ttf
15131652

@@ -1516,17 +1655,16 @@ DOT_FONTNAME = FreeSans.ttf
15161655

15171656
DOT_FONTSIZE = 10
15181657

1519-
# By default doxygen will tell dot to use the output directory to look for the
1520-
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1521-
# different font using DOT_FONTNAME you can set the path where dot
1522-
# can find it using this tag.
1658+
# By default doxygen will tell dot to use the Helvetica font.
1659+
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1660+
# set the path where dot can find it.
15231661

15241662
DOT_FONTPATH =
15251663

15261664
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
15271665
# will generate a graph for each documented class showing the direct and
15281666
# indirect inheritance relations. Setting this tag to YES will force the
1529-
# the CLASS_DIAGRAMS tag to NO.
1667+
# CLASS_DIAGRAMS tag to NO.
15301668

15311669
CLASS_GRAPH = YES
15321670

@@ -1548,6 +1686,15 @@ GROUP_GRAPHS = YES
15481686

15491687
UML_LOOK = NO
15501688

1689+
# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1690+
# the class node. If there are many fields or methods and many nodes the
1691+
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1692+
# threshold limits the number of items for each type to make the size more
1693+
# managable. Set this to 0 for no limit. Note that the threshold may be
1694+
# exceeded by 50% before the limit is enforced.
1695+
1696+
UML_LIMIT_NUM_FIELDS = 10
1697+
15511698
# If set to YES, the inheritance and collaboration graphs will show the
15521699
# relations between templates and their instances.
15531700

@@ -1584,23 +1731,34 @@ CALL_GRAPH = NO
15841731
CALLER_GRAPH = NO
15851732

15861733
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1587-
# will graphical hierarchy of all classes instead of a textual one.
1734+
# will generate a graphical hierarchy of all classes instead of a textual one.
15881735

15891736
GRAPHICAL_HIERARCHY = YES
15901737

1591-
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1738+
# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
15921739
# then doxygen will show the dependencies a directory has on other directories
15931740
# in a graphical way. The dependency relations are determined by the #include
15941741
# relations between the files in the directories.
15951742

15961743
DIRECTORY_GRAPH = YES
15971744

15981745
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1599-
# generated by dot. Possible values are png, jpg, or gif
1600-
# If left blank png will be used.
1746+
# generated by dot. Possible values are svg, png, jpg, or gif.
1747+
# If left blank png will be used. If you choose svg you need to set
1748+
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1749+
# visible in IE 9+ (other browsers do not have this requirement).
16011750

16021751
DOT_IMAGE_FORMAT = png
16031752

1753+
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1754+
# enable generation of interactive SVG images that allow zooming and panning.
1755+
# Note that this requires a modern browser other than Internet Explorer.
1756+
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1757+
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1758+
# visible. Older versions of IE do not have SVG support.
1759+
1760+
INTERACTIVE_SVG = NO
1761+
16041762
# The tag DOT_PATH can be used to specify the path where the dot tool can be
16051763
# found. If left blank, it is assumed the dot tool can be found in the path.
16061764

@@ -1612,6 +1770,12 @@ DOT_PATH =
16121770

16131771
DOTFILE_DIRS =
16141772

1773+
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1774+
# contain msc files that are included in the documentation (see the
1775+
# \mscfile command).
1776+
1777+
MSCFILE_DIRS =
1778+
16151779
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
16161780
# nodes that will be shown in the graph. If the number of nodes in a graph
16171781
# becomes larger than this value, doxygen will truncate the graph, which is

0 commit comments

Comments
 (0)
Please sign in to comment.