Skip to content

Commit 23b0dac

Browse files
committed
add Doxyfile.in
1 parent 7fbb108 commit 23b0dac

File tree

1 file changed

+278
-0
lines changed

1 file changed

+278
-0
lines changed

cmake/Doxyfile.in

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,278 @@
1+
# Copyright (c) 2019 Geode-solutions
2+
#
3+
# Permission is hereby granted, free of charge, to any person obtaining a copy
4+
# of this software and associated documentation files (the "Software"), to deal
5+
# in the Software without restriction, including without limitation the rights
6+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
# copies of the Software, and to permit persons to whom the Software is
8+
# furnished to do so, subject to the following conditions:
9+
#
10+
# The above copyright notice and this permission notice shall be included in
11+
# all copies or substantial portions of the Software.
12+
#
13+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
# SOFTWARE.
20+
21+
# Doxyfile 1.6.1
22+
23+
#---------------------------------------------------------------------------
24+
# Project related configuration options
25+
#---------------------------------------------------------------------------
26+
DOXYFILE_ENCODING = UTF-8
27+
PROJECT_NAME = @CMAKE_PROJECT_NAME@
28+
PROJECT_NUMBER =
29+
OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/doc
30+
CREATE_SUBDIRS = NO
31+
OUTPUT_LANGUAGE = English
32+
BRIEF_MEMBER_DESC = YES
33+
REPEAT_BRIEF = YES
34+
ABBREVIATE_BRIEF =
35+
ALWAYS_DETAILED_SEC = NO
36+
INLINE_INHERITED_MEMB = NO
37+
FULL_PATH_NAMES = YES
38+
STRIP_FROM_PATH =
39+
STRIP_FROM_INC_PATH =
40+
SHORT_NAMES = NO
41+
JAVADOC_AUTOBRIEF = NO
42+
QT_AUTOBRIEF = NO
43+
MULTILINE_CPP_IS_BRIEF = NO
44+
INHERIT_DOCS = YES
45+
SEPARATE_MEMBER_PAGES = NO
46+
TAB_SIZE = 4
47+
ALIASES =
48+
OPTIMIZE_OUTPUT_FOR_C = NO
49+
OPTIMIZE_OUTPUT_JAVA = NO
50+
OPTIMIZE_FOR_FORTRAN = NO
51+
OPTIMIZE_OUTPUT_VHDL = NO
52+
EXTENSION_MAPPING =
53+
BUILTIN_STL_SUPPORT = NO
54+
CPP_CLI_SUPPORT = NO
55+
SIP_SUPPORT = NO
56+
IDL_PROPERTY_SUPPORT = YES
57+
DISTRIBUTE_GROUP_DOC = NO
58+
SUBGROUPING = YES
59+
TYPEDEF_HIDES_STRUCT = NO
60+
SYMBOL_CACHE_SIZE = 0
61+
#---------------------------------------------------------------------------
62+
# Build related configuration options
63+
#---------------------------------------------------------------------------
64+
EXTRACT_ALL = YES
65+
EXTRACT_PRIVATE = NO
66+
EXTRACT_STATIC = NO
67+
EXTRACT_LOCAL_CLASSES = YES
68+
EXTRACT_LOCAL_METHODS = NO
69+
EXTRACT_ANON_NSPACES = NO
70+
HIDE_UNDOC_MEMBERS = NO
71+
HIDE_UNDOC_CLASSES = NO
72+
HIDE_FRIEND_COMPOUNDS = NO
73+
HIDE_IN_BODY_DOCS = NO
74+
INTERNAL_DOCS = NO
75+
CASE_SENSE_NAMES = NO
76+
HIDE_SCOPE_NAMES = NO
77+
SHOW_INCLUDE_FILES = YES
78+
INLINE_INFO = YES
79+
SORT_MEMBER_DOCS = YES
80+
SORT_BRIEF_DOCS = NO
81+
SORT_MEMBERS_CTORS_1ST = NO
82+
SORT_GROUP_NAMES = NO
83+
SORT_BY_SCOPE_NAME = NO
84+
GENERATE_TODOLIST = YES
85+
GENERATE_TESTLIST = YES
86+
GENERATE_BUGLIST = YES
87+
GENERATE_DEPRECATEDLIST= YES
88+
ENABLED_SECTIONS =
89+
MAX_INITIALIZER_LINES = 30
90+
SHOW_USED_FILES = NO
91+
SHOW_DIRECTORIES = NO
92+
SHOW_FILES = NO
93+
SHOW_NAMESPACES = YES
94+
FILE_VERSION_FILTER =
95+
LAYOUT_FILE =
96+
#---------------------------------------------------------------------------
97+
# configuration options related to warning and progress messages
98+
#---------------------------------------------------------------------------
99+
QUIET = NO
100+
WARNINGS = YES
101+
WARN_IF_UNDOCUMENTED = NO
102+
WARN_IF_DOC_ERROR = YES
103+
WARN_NO_PARAMDOC = NO
104+
WARN_FORMAT = "$file:$line: $text"
105+
WARN_LOGFILE =
106+
#---------------------------------------------------------------------------
107+
# configuration options related to the input files
108+
#---------------------------------------------------------------------------
109+
INPUT = @CMAKE_SOURCE_DIR@/include @CMAKE_SOURCE_DIR@/docs
110+
INPUT_ENCODING = UTF-8
111+
FILE_PATTERNS = *.h *.dox
112+
RECURSIVE = YES
113+
EXCLUDE =
114+
EXCLUDE_SYMLINKS = NO
115+
EXCLUDE_PATTERNS =
116+
EXCLUDE_SYMBOLS =
117+
EXAMPLE_PATH =
118+
EXAMPLE_PATTERNS =
119+
EXAMPLE_RECURSIVE = NO
120+
IMAGE_PATH =
121+
INPUT_FILTER =
122+
FILTER_PATTERNS =
123+
FILTER_SOURCE_FILES = NO
124+
#---------------------------------------------------------------------------
125+
# configuration options related to source browsing
126+
#---------------------------------------------------------------------------
127+
SOURCE_BROWSER = NO
128+
INLINE_SOURCES = NO
129+
STRIP_CODE_COMMENTS = YES
130+
REFERENCED_BY_RELATION = NO
131+
REFERENCES_RELATION = NO
132+
REFERENCES_LINK_SOURCE = YES
133+
USE_HTAGS = NO
134+
VERBATIM_HEADERS = YES
135+
#---------------------------------------------------------------------------
136+
# configuration options related to the alphabetical class index
137+
#---------------------------------------------------------------------------
138+
ALPHABETICAL_INDEX = NO
139+
COLS_IN_ALPHA_INDEX = 5
140+
IGNORE_PREFIX =
141+
#---------------------------------------------------------------------------
142+
# configuration options related to the HTML output
143+
#---------------------------------------------------------------------------
144+
GENERATE_HTML = YES
145+
HTML_OUTPUT = html
146+
HTML_FILE_EXTENSION = .html
147+
HTML_HEADER =
148+
HTML_FOOTER =
149+
HTML_TIMESTAMP = NO
150+
HTML_STYLESHEET =
151+
HTML_ALIGN_MEMBERS = YES
152+
HTML_DYNAMIC_SECTIONS = NO
153+
GENERATE_DOCSET = NO
154+
DOCSET_FEEDNAME = "Doxygen generated docs"
155+
DOCSET_BUNDLE_ID = org.doxygen.Project
156+
GENERATE_HTMLHELP = NO
157+
CHM_FILE =
158+
HHC_LOCATION =
159+
GENERATE_CHI = NO
160+
CHM_INDEX_ENCODING =
161+
BINARY_TOC = NO
162+
TOC_EXPAND = NO
163+
GENERATE_QHP = YES
164+
QCH_FILE = @[email protected]
165+
QHP_NAMESPACE = @CMAKE_PROJECT_NAME@
166+
QHP_VIRTUAL_FOLDER = doc
167+
QHP_CUST_FILTER_NAME =
168+
QHP_CUST_FILTER_ATTRS =
169+
QHP_SECT_FILTER_ATTRS =
170+
QHG_LOCATION =
171+
DISABLE_INDEX = NO
172+
ENUM_VALUES_PER_LINE = 4
173+
GENERATE_TREEVIEW = NO
174+
USE_INLINE_TREES = NO
175+
TREEVIEW_WIDTH = 250
176+
FORMULA_FONTSIZE = 10
177+
SEARCHENGINE = YES
178+
#---------------------------------------------------------------------------
179+
# configuration options related to the LaTeX output
180+
#---------------------------------------------------------------------------
181+
GENERATE_LATEX = NO
182+
LATEX_OUTPUT = latex
183+
LATEX_CMD_NAME = latex
184+
MAKEINDEX_CMD_NAME = makeindex
185+
COMPACT_LATEX = NO
186+
PAPER_TYPE = a4wide
187+
EXTRA_PACKAGES =
188+
LATEX_HEADER =
189+
PDF_HYPERLINKS = YES
190+
USE_PDFLATEX = YES
191+
LATEX_BATCHMODE = NO
192+
LATEX_HIDE_INDICES = NO
193+
LATEX_SOURCE_CODE = NO
194+
#---------------------------------------------------------------------------
195+
# configuration options related to the RTF output
196+
#---------------------------------------------------------------------------
197+
GENERATE_RTF = NO
198+
RTF_OUTPUT = rtf
199+
COMPACT_RTF = NO
200+
RTF_HYPERLINKS = NO
201+
RTF_STYLESHEET_FILE =
202+
RTF_EXTENSIONS_FILE =
203+
#---------------------------------------------------------------------------
204+
# configuration options related to the man page output
205+
#---------------------------------------------------------------------------
206+
GENERATE_MAN = NO
207+
MAN_OUTPUT = man
208+
MAN_EXTENSION = .3
209+
MAN_LINKS = NO
210+
#---------------------------------------------------------------------------
211+
# configuration options related to the XML output
212+
#---------------------------------------------------------------------------
213+
GENERATE_XML = YES
214+
XML_OUTPUT = xml
215+
XML_SCHEMA =
216+
XML_DTD =
217+
XML_PROGRAMLISTING = NO
218+
#---------------------------------------------------------------------------
219+
# configuration options for the AutoGen Definitions output
220+
#---------------------------------------------------------------------------
221+
GENERATE_AUTOGEN_DEF = NO
222+
#---------------------------------------------------------------------------
223+
# configuration options related to the Perl module output
224+
#---------------------------------------------------------------------------
225+
GENERATE_PERLMOD = NO
226+
PERLMOD_LATEX = NO
227+
PERLMOD_PRETTY = YES
228+
PERLMOD_MAKEVAR_PREFIX =
229+
#---------------------------------------------------------------------------
230+
# Configuration options related to the preprocessor
231+
#---------------------------------------------------------------------------
232+
ENABLE_PREPROCESSING = YES
233+
MACRO_EXPANSION = NO
234+
EXPAND_ONLY_PREDEF = NO
235+
SEARCH_INCLUDES = YES
236+
INCLUDE_PATH =
237+
INCLUDE_FILE_PATTERNS =
238+
PREDEFINED =
239+
EXPAND_AS_DEFINED =
240+
SKIP_FUNCTION_MACROS = YES
241+
#---------------------------------------------------------------------------
242+
# Configuration::additions related to external references
243+
#---------------------------------------------------------------------------
244+
TAGFILES =
245+
GENERATE_TAGFILE =
246+
ALLEXTERNALS = NO
247+
EXTERNAL_GROUPS = YES
248+
PERL_PATH = /usr/bin/perl
249+
#---------------------------------------------------------------------------
250+
# Configuration options related to the dot tool
251+
#---------------------------------------------------------------------------
252+
CLASS_DIAGRAMS = YES
253+
MSCGEN_PATH =
254+
HIDE_UNDOC_RELATIONS = YES
255+
HAVE_DOT = NO
256+
DOT_FONTNAME = FreeSans
257+
DOT_FONTSIZE = 10
258+
DOT_FONTPATH =
259+
CLASS_GRAPH = YES
260+
COLLABORATION_GRAPH = YES
261+
GROUP_GRAPHS = YES
262+
UML_LOOK = NO
263+
TEMPLATE_RELATIONS = NO
264+
INCLUDE_GRAPH = YES
265+
INCLUDED_BY_GRAPH = YES
266+
CALL_GRAPH = NO
267+
CALLER_GRAPH = NO
268+
GRAPHICAL_HIERARCHY = YES
269+
DIRECTORY_GRAPH = YES
270+
DOT_IMAGE_FORMAT = png
271+
DOT_PATH =
272+
DOTFILE_DIRS =
273+
DOT_GRAPH_MAX_NODES = 50
274+
MAX_DOT_GRAPH_DEPTH = 0
275+
DOT_TRANSPARENT = NO
276+
DOT_MULTI_TARGETS = NO
277+
GENERATE_LEGEND = YES
278+
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)