1 # Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #---------------------------------------------------------------------------
24 # Project related configuration options
25 #---------------------------------------------------------------------------
26 PROJECT_NAME = "SALOME KERNEL Reference Guide"
28 OUTPUT_DIRECTORY = KERNEL
30 OUTPUT_LANGUAGE = English
31 USE_WINDOWS_ENCODING = NO
32 BRIEF_MEMBER_DESC = YES
35 ALWAYS_DETAILED_SEC = YES
36 INLINE_INHERITED_MEMB = YES
38 STRIP_FROM_PATH = @PROJECT_BINARY_DIR@ @PROJECT_SOURCE_DIR@
41 JAVADOC_AUTOBRIEF = YES
43 MULTILINE_CPP_IS_BRIEF = NO
46 SEPARATE_MEMBER_PAGES = NO
49 OPTIMIZE_OUTPUT_FOR_C = YES
50 OPTIMIZE_OUTPUT_JAVA = YES
51 BUILTIN_STL_SUPPORT = @DOXYGEN_SUPPORT_STL@
52 DISTRIBUTE_GROUP_DOC = NO
55 #---------------------------------------------------------------------------
56 # Build related configuration options
57 #---------------------------------------------------------------------------
61 EXTRACT_LOCAL_CLASSES = YES
62 EXTRACT_LOCAL_METHODS = YES
63 HIDE_UNDOC_MEMBERS = NO
64 HIDE_UNDOC_CLASSES = NO
65 HIDE_FRIEND_COMPOUNDS = NO
66 HIDE_IN_BODY_DOCS = NO
68 CASE_SENSE_NAMES = YES
70 SHOW_INCLUDE_FILES = YES
72 SORT_MEMBER_DOCS = YES
74 SORT_BY_SCOPE_NAME = YES
75 GENERATE_TODOLIST = YES
76 GENERATE_TESTLIST = YES
77 GENERATE_BUGLIST = YES
78 GENERATE_DEPRECATEDLIST= YES
80 MAX_INITIALIZER_LINES = 25
85 #---------------------------------------------------------------------------
86 # configuration options related to warning and progress messages
87 #---------------------------------------------------------------------------
90 WARN_IF_UNDOCUMENTED = YES
91 WARN_IF_DOC_ERROR = YES
93 WARN_FORMAT = "$file:$line: $text"
94 WARN_LOGFILE = log.txt
96 #---------------------------------------------------------------------------
97 # configuration options related to the input files
98 #---------------------------------------------------------------------------
99 INPUT = @CMAKE_CURRENT_BINARY_DIR@/tmp \
100 @PROJECT_SOURCE_DIR@/doc/salome \
101 @PROJECT_SOURCE_DIR@/src \
102 @PROJECT_SOURCE_DIR@/bin \
103 @PROJECT_SOURCE_DIR@/idl \
104 @PROJECT_BINARY_DIR@/bin \
105 FILE_PATTERNS = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc *.dox
108 EXCLUDE_SYMLINKS = NO
110 EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/doc/salome/examples
112 EXAMPLE_RECURSIVE = NO
113 IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/images
116 FILTER_SOURCE_FILES = YES
118 #---------------------------------------------------------------------------
119 # configuration options related to source browsing
120 #---------------------------------------------------------------------------
123 STRIP_CODE_COMMENTS = YES
124 REFERENCED_BY_RELATION = YES
125 REFERENCES_RELATION = YES
127 VERBATIM_HEADERS = YES
129 #---------------------------------------------------------------------------
130 # configuration options related to the alphabetical class index
131 #---------------------------------------------------------------------------
132 ALPHABETICAL_INDEX = YES
133 COLS_IN_ALPHA_INDEX = 3
136 #---------------------------------------------------------------------------
137 # configuration options related to the HTML output
138 #---------------------------------------------------------------------------
141 HTML_FILE_EXTENSION = .html
142 HTML_HEADER = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
143 HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
144 HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
145 HTML_ALIGN_MEMBERS = YES
146 GENERATE_HTMLHELP = NO
153 ENUM_VALUES_PER_LINE = 4
154 GENERATE_TREEVIEW = YES
157 #---------------------------------------------------------------------------
158 # configuration options related to the LaTeX output
159 #---------------------------------------------------------------------------
162 LATEX_CMD_NAME = latex
163 MAKEINDEX_CMD_NAME = makeindex
171 LATEX_HIDE_INDICES = NO
173 #---------------------------------------------------------------------------
174 # configuration options related to the RTF output
175 #---------------------------------------------------------------------------
180 RTF_STYLESHEET_FILE =
181 RTF_EXTENSIONS_FILE =
183 #---------------------------------------------------------------------------
184 # configuration options related to the man page output
185 #---------------------------------------------------------------------------
191 #---------------------------------------------------------------------------
192 # configuration options related to the XML output
193 #---------------------------------------------------------------------------
198 XML_PROGRAMLISTING = YES
200 #---------------------------------------------------------------------------
201 # configuration options for the AutoGen Definitions output
202 #---------------------------------------------------------------------------
203 GENERATE_AUTOGEN_DEF = NO
205 #---------------------------------------------------------------------------
206 # configuration options related to the Perl module output
207 #---------------------------------------------------------------------------
208 GENERATE_PERLMOD = NO
211 PERLMOD_MAKEVAR_PREFIX =
213 #---------------------------------------------------------------------------
214 # Configuration options related to the preprocessor
215 #---------------------------------------------------------------------------
216 ENABLE_PREPROCESSING = YES
217 MACRO_EXPANSION = YES
218 EXPAND_ONLY_PREDEF = NO
219 SEARCH_INCLUDES = YES
221 INCLUDE_FILE_PATTERNS =
224 SKIP_FUNCTION_MACROS = NO
226 #---------------------------------------------------------------------------
227 # Configuration::additions related to external references
228 #---------------------------------------------------------------------------
232 EXTERNAL_GROUPS = YES
233 PERL_PATH = /usr/bin/perl
235 #---------------------------------------------------------------------------
236 # Configuration options related to the dot tool
237 #---------------------------------------------------------------------------
239 HIDE_UNDOC_RELATIONS = NO
242 COLLABORATION_GRAPH = NO
245 TEMPLATE_RELATIONS = YES
247 INCLUDED_BY_GRAPH = YES
249 GRAPHICAL_HIERARCHY = YES
250 DIRECTORY_GRAPH = YES
251 DOT_IMAGE_FORMAT = png
255 MAX_DOT_GRAPH_WIDTH = 1024
256 MAX_DOT_GRAPH_HEIGHT = 1200
257 MAX_DOT_GRAPH_DEPTH = 0
259 DOT_MULTI_TARGETS = NO
260 GENERATE_LEGEND = YES
263 #---------------------------------------------------------------------------
264 # Configuration::additions related to the search engine
265 #---------------------------------------------------------------------------