Skip to content
GitLab
Select Git revision
  • dev default
  • main
  • 1.2
  • 1.1
  • 1.0
Find file BlameHistoryPermalink
Doxyfile 127.94 KiB
1 
# Doxyfile 1.12.0
2
3 
# This file describes the settings to be used by the documentation system
4 
# Doxygen (www.doxygen.org) for a project.
5 
#
6 
# All text after a double hash (##) is considered a comment and is placed in
7 
# front of the TAG it is preceding.
8 
#
9 
# All text after a single hash (#) is considered a comment and will be ignored.
10 
# The format is:
11 
# TAG = value [value, ...]
12 
# For lists, items can also be appended using:
13 
# TAG += value [value, ...]
14 
# Values that contain spaces should be placed between quotes (\" \").
15 
#
16 
# Note:
17 
#
18 
# Use Doxygen to compare the used configuration file with the template
19 
# configuration file:
20 
# doxygen -x [configFile]
21 
# Use Doxygen to compare the used configuration file with the template
22 
# configuration file without replacing the environment variables or CMake type
23 
# replacement variables:
24 
# doxygen -x_noenv [configFile]
25
26 
#---------------------------------------------------------------------------
27 
# Project related configuration options
28 
#---------------------------------------------------------------------------
29
30 
# This tag specifies the encoding used for all characters in the configuration
31 
# file that follow. The default is UTF-8 which is also the encoding used for all
32 
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
33 
# iconv built into libc) for the transcoding. See
34 
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35 
# The default value is: UTF-8.
36
37 
DOXYFILE_ENCODING      = UTF-8
38
39 
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40 
# double-quotes, unless you are using Doxywizard) that should identify the
41 
# project for which the documentation is generated. This name is used in the
42 
# title of most generated pages and in a few other places.
43 
# The default value is: My Project.
44
45 
PROJECT_NAME           = "Fusion Directory Integrator"
46
47 
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48 
# could be handy for archiving the generated documentation or if some version
49 
# control system is used.
50
51 
PROJECT_NUMBER         =
52
53 
# Using the PROJECT_BRIEF tag one can provide an optional one line description
54 
# for a project that appears at the top of each page and should give viewer a
55 
# quick idea about the purpose of the project. Keep the description short.
56
57 
PROJECT_BRIEF          =
58
59 
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60 
# in the documentation. The maximum height of the logo should not exceed 55
61 
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62 
# the logo to the output directory.
63
64 
PROJECT_LOGO           =
65
66 
# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67 
# when the HTML document is shown. Doxygen will copy the logo to the output
68 
# directory.
69
70 
PROJECT_ICON           =
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format # and will distribute the generated files over these directories. Enabling this # option can be useful when feeding Doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to # control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO # Controls the number of sub-directories that will be created when # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every # level increment doubles the number of directories, resulting in 4096 # directories at level 8 which is the default and also the maximum value. The # sub-directories are organized in 2 levels, the first level always has a fixed # number of 16 directories. # Minimum value: 0, maximum value: 8, default value: 8. # This tag requires that the tag CREATE_SUBDIRS is set to YES. CREATE_SUBDIRS_LEVEL = 8 # If the ALLOW_UNICODE_NAMES tag is set to YES, Doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by Doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with # English messages), Korean, Korean-en (Korean with English messages), Latvian, # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, # Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, Doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, Doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is