3 #---------------------------------------------------------------------------
4 # Project related configuration options
5 #---------------------------------------------------------------------------
6 DOXYFILE_ENCODING = UTF-8
7 PROJECT_NAME = PeakEngine
9 OUTPUT_DIRECTORY = doc/doxygen
11 OUTPUT_LANGUAGE = English
12 BRIEF_MEMBER_DESC = YES
15 ALWAYS_DETAILED_SEC = NO
16 INLINE_INHERITED_MEMB = NO
21 JAVADOC_AUTOBRIEF = NO
23 MULTILINE_CPP_IS_BRIEF = NO
26 SEPARATE_MEMBER_PAGES = NO
29 OPTIMIZE_OUTPUT_FOR_C = NO
30 OPTIMIZE_OUTPUT_JAVA = NO
31 OPTIMIZE_FOR_FORTRAN = NO
32 OPTIMIZE_OUTPUT_VHDL = NO
33 BUILTIN_STL_SUPPORT = NO
36 DISTRIBUTE_GROUP_DOC = NO
38 TYPEDEF_HIDES_STRUCT = NO
39 #---------------------------------------------------------------------------
40 # Build related configuration options
41 #---------------------------------------------------------------------------
45 EXTRACT_LOCAL_CLASSES = NO
46 EXTRACT_LOCAL_METHODS = NO
47 EXTRACT_ANON_NSPACES = NO
48 HIDE_UNDOC_MEMBERS = NO
49 HIDE_UNDOC_CLASSES = NO
50 HIDE_FRIEND_COMPOUNDS = NO
51 HIDE_IN_BODY_DOCS = NO
53 CASE_SENSE_NAMES = YES
55 SHOW_INCLUDE_FILES = YES
57 SORT_MEMBER_DOCS = YES
60 SORT_BY_SCOPE_NAME = NO
61 GENERATE_TODOLIST = YES
62 GENERATE_TESTLIST = YES
63 GENERATE_BUGLIST = YES
64 GENERATE_DEPRECATEDLIST= YES
66 MAX_INITIALIZER_LINES = 30
68 SHOW_DIRECTORIES = YES
70 #---------------------------------------------------------------------------
71 # configuration options related to warning and progress messages
72 #---------------------------------------------------------------------------
75 WARN_IF_UNDOCUMENTED = YES
76 WARN_IF_DOC_ERROR = YES
77 WARN_NO_PARAMDOC = YES
78 WARN_FORMAT = "$file:$line: $text"
80 #---------------------------------------------------------------------------
81 # configuration options related to the input files
82 #---------------------------------------------------------------------------
83 INPUT = "engine/include"
84 INPUT_ENCODING = UTF-8
85 FILE_PATTERNS = *.cpp \
94 EXAMPLE_RECURSIVE = NO
98 FILTER_SOURCE_FILES = NO
99 #---------------------------------------------------------------------------
100 # configuration options related to source browsing
101 #---------------------------------------------------------------------------
104 STRIP_CODE_COMMENTS = YES
105 REFERENCED_BY_RELATION = YES
106 REFERENCES_RELATION = YES
107 REFERENCES_LINK_SOURCE = YES
109 VERBATIM_HEADERS = YES
110 #---------------------------------------------------------------------------
111 # configuration options related to the alphabetical class index
112 #---------------------------------------------------------------------------
113 ALPHABETICAL_INDEX = YES
114 COLS_IN_ALPHA_INDEX = 5
116 #---------------------------------------------------------------------------
117 # configuration options related to the HTML output
118 #---------------------------------------------------------------------------
121 HTML_FILE_EXTENSION = .html
125 HTML_ALIGN_MEMBERS = YES
126 GENERATE_HTMLHELP = NO
128 DOCSET_FEEDNAME = "Doxygen generated docs"
129 DOCSET_BUNDLE_ID = org.doxygen.Project
130 HTML_DYNAMIC_SECTIONS = NO
137 ENUM_VALUES_PER_LINE = 4
138 GENERATE_TREEVIEW = NO
140 #---------------------------------------------------------------------------
141 # configuration options related to the LaTeX output
142 #---------------------------------------------------------------------------
145 LATEX_CMD_NAME = latex
146 MAKEINDEX_CMD_NAME = makeindex
154 LATEX_HIDE_INDICES = NO
155 #---------------------------------------------------------------------------
156 # configuration options related to the RTF output
157 #---------------------------------------------------------------------------
162 RTF_STYLESHEET_FILE =
163 RTF_EXTENSIONS_FILE =
164 #---------------------------------------------------------------------------
165 # configuration options related to the man page output
166 #---------------------------------------------------------------------------
171 #---------------------------------------------------------------------------
172 # configuration options related to the XML output
173 #---------------------------------------------------------------------------
178 XML_PROGRAMLISTING = YES
179 #---------------------------------------------------------------------------
180 # configuration options for the AutoGen Definitions output
181 #---------------------------------------------------------------------------
182 GENERATE_AUTOGEN_DEF = NO
183 #---------------------------------------------------------------------------
184 # configuration options related to the Perl module output
185 #---------------------------------------------------------------------------
186 GENERATE_PERLMOD = NO
189 PERLMOD_MAKEVAR_PREFIX =
190 #---------------------------------------------------------------------------
191 # Configuration options related to the preprocessor
192 #---------------------------------------------------------------------------
193 ENABLE_PREPROCESSING = YES
195 EXPAND_ONLY_PREDEF = NO
196 SEARCH_INCLUDES = YES
198 INCLUDE_FILE_PATTERNS =
201 SKIP_FUNCTION_MACROS = YES
202 #---------------------------------------------------------------------------
203 # Configuration::additions related to external references
204 #---------------------------------------------------------------------------
208 EXTERNAL_GROUPS = YES
209 PERL_PATH = /usr/bin/perl
210 #---------------------------------------------------------------------------
211 # Configuration options related to the dot tool
212 #---------------------------------------------------------------------------
215 HIDE_UNDOC_RELATIONS = NO
218 COLLABORATION_GRAPH = YES
221 TEMPLATE_RELATIONS = NO
223 INCLUDED_BY_GRAPH = YES
226 GRAPHICAL_HIERARCHY = YES
227 DIRECTORY_GRAPH = YES
228 DOT_IMAGE_FORMAT = png
231 DOT_GRAPH_MAX_NODES = 50
232 MAX_DOT_GRAPH_DEPTH = 0
233 DOT_TRANSPARENT = YES
234 DOT_MULTI_TARGETS = NO
235 GENERATE_LEGEND = YES
237 #---------------------------------------------------------------------------
238 # Configuration::additions related to the search engine
239 #---------------------------------------------------------------------------