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