Salome HOME
Rework building procedure and testing environment
[modules/shaper.git] / doc / swig / doxyfile.in
1 #---------------------------------------------------------------------------
2 # Project related configuration options
3 #---------------------------------------------------------------------------
4 DOXYFILE_ENCODING      = UTF-8
5 PROJECT_NAME           = @CMAKE_PROJECT_NAME@
6 PROJECT_NUMBER         = @SHAPER_VERSION@
7 PROJECT_BRIEF          =
8 PROJECT_LOGO           =
9 OUTPUT_DIRECTORY       =
10 CREATE_SUBDIRS         = NO
11 OUTPUT_LANGUAGE        = English
12 BRIEF_MEMBER_DESC      = YES
13 REPEAT_BRIEF           = YES
14 ABBREVIATE_BRIEF       =
15 ALWAYS_DETAILED_SEC    = YES
16 INLINE_INHERITED_MEMB  = YES
17 FULL_PATH_NAMES        = YES
18 STRIP_FROM_PATH        = @PROJECT_BINARY_DIR@ \
19                          @PROJECT_SOURCE_DIR@
20 STRIP_FROM_INC_PATH    =
21 SHORT_NAMES            = NO
22 JAVADOC_AUTOBRIEF      = YES
23 QT_AUTOBRIEF           = NO
24 MULTILINE_CPP_IS_BRIEF = NO
25 INHERIT_DOCS           = YES
26 SEPARATE_MEMBER_PAGES  = NO
27 TAB_SIZE               = 5
28 ALIASES                =
29 TCL_SUBST              =
30 OPTIMIZE_OUTPUT_FOR_C  = YES
31 OPTIMIZE_OUTPUT_JAVA   = NO
32 OPTIMIZE_FOR_FORTRAN   = NO
33 OPTIMIZE_OUTPUT_VHDL   = NO
34 EXTENSION_MAPPING      =
35 MARKDOWN_SUPPORT       = YES
36 AUTOLINK_SUPPORT       = YES
37 BUILTIN_STL_SUPPORT    = NO
38 CPP_CLI_SUPPORT        = NO
39 SIP_SUPPORT            = NO
40 IDL_PROPERTY_SUPPORT   = YES
41 DISTRIBUTE_GROUP_DOC   = NO
42 SUBGROUPING            = YES
43 INLINE_GROUPED_CLASSES = NO
44 INLINE_SIMPLE_STRUCTS  = NO
45 TYPEDEF_HIDES_STRUCT   = NO
46 #SYMBOL_CACHE_SIZE      = 0
47 LOOKUP_CACHE_SIZE      = 0
48 #---------------------------------------------------------------------------
49 # Build related configuration options
50 #---------------------------------------------------------------------------
51 EXTRACT_ALL            = NO
52 EXTRACT_PRIVATE        = NO
53 EXTRACT_PACKAGE        = NO
54 EXTRACT_STATIC         = YES
55 EXTRACT_LOCAL_CLASSES  = YES
56 EXTRACT_LOCAL_METHODS  = NO
57 EXTRACT_ANON_NSPACES   = NO
58 HIDE_UNDOC_MEMBERS     = NO
59 HIDE_UNDOC_CLASSES     = NO
60 HIDE_FRIEND_COMPOUNDS  = NO
61 HIDE_IN_BODY_DOCS      = NO
62 INTERNAL_DOCS          = YES
63 CASE_SENSE_NAMES       = YES
64 HIDE_SCOPE_NAMES       = NO
65 SHOW_INCLUDE_FILES     = NO
66 FORCE_LOCAL_INCLUDES   = NO
67 INLINE_INFO            = YES
68 SORT_MEMBER_DOCS       = NO
69 SORT_BRIEF_DOCS        = NO
70 SORT_MEMBERS_CTORS_1ST = NO
71 SORT_GROUP_NAMES       = NO
72 SORT_BY_SCOPE_NAME     = YES
73 STRICT_PROTO_MATCHING  = NO
74 GENERATE_TODOLIST      = NO
75 GENERATE_TESTLIST      = NO
76 GENERATE_BUGLIST       = NO
77 GENERATE_DEPRECATEDLIST= NO
78 ENABLED_SECTIONS       =
79 MAX_INITIALIZER_LINES  = 25
80 SHOW_USED_FILES        = NO
81 SHOW_FILES             = YES
82 SHOW_NAMESPACES        = YES
83 FILE_VERSION_FILTER    =
84 LAYOUT_FILE            =
85 CITE_BIB_FILES         =
86 #---------------------------------------------------------------------------
87 # configuration options related to warning and progress messages
88 #---------------------------------------------------------------------------
89 QUIET                  = NO
90 WARNINGS               = YES
91 WARN_IF_UNDOCUMENTED   = YES
92 WARN_IF_DOC_ERROR      = YES
93 WARN_NO_PARAMDOC       = NO
94 WARN_FORMAT            = "$file:$line: $text"
95 WARN_LOGFILE           = log.txt
96 #---------------------------------------------------------------------------
97 # configuration options related to the input files
98 #---------------------------------------------------------------------------
99 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@ 
100 INPUT_ENCODING         = UTF-8
101 FILE_PATTERNS          = *.h \
102                          *.cpp \
103                          *.hxx \
104                          *.cxx \
105                          *.doc \
106                          *.py
107 RECURSIVE              = YES
108 EXCLUDE                =
109 EXCLUDE_SYMLINKS       = NO
110 EXCLUDE_PATTERNS       = */Test/* @EXCLUDE_DOC_DIR@
111 EXCLUDE_SYMBOLS        =
112 EXAMPLE_PATH           =
113 EXAMPLE_PATTERNS       =
114 EXAMPLE_RECURSIVE      = NO
115 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@
116 INPUT_FILTER           =
117 FILTER_PATTERNS        =
118 FILTER_SOURCE_FILES    = NO
119 FILTER_SOURCE_PATTERNS =
120 USE_MDFILE_AS_MAINPAGE =
121 #---------------------------------------------------------------------------
122 # configuration options related to source browsing
123 #---------------------------------------------------------------------------
124 SOURCE_BROWSER         = NO
125 INLINE_SOURCES         = NO
126 STRIP_CODE_COMMENTS    = YES
127 REFERENCED_BY_RELATION = NO
128 REFERENCES_RELATION    = NO
129 REFERENCES_LINK_SOURCE = YES
130 USE_HTAGS              = NO
131 VERBATIM_HEADERS       = YES
132 #---------------------------------------------------------------------------
133 # configuration options related to the alphabetical class index
134 #---------------------------------------------------------------------------
135 ALPHABETICAL_INDEX     = YES
136 COLS_IN_ALPHA_INDEX    = 3
137 IGNORE_PREFIX          =
138 #---------------------------------------------------------------------------
139 # configuration options related to the HTML output
140 #---------------------------------------------------------------------------
141 GENERATE_HTML          = NO
142 HTML_OUTPUT            = .
143 HTML_FILE_EXTENSION    = .html
144 HTML_HEADER            =
145 HTML_FOOTER            = 
146 HTML_STYLESHEET        =
147 HTML_EXTRA_STYLESHEET  =
148 HTML_EXTRA_FILES       =
149 HTML_COLORSTYLE_HUE    = 220
150 HTML_COLORSTYLE_SAT    = 100
151 HTML_COLORSTYLE_GAMMA  = 80
152 HTML_TIMESTAMP         = YES
153 HTML_DYNAMIC_SECTIONS  = NO
154 HTML_INDEX_NUM_ENTRIES = 100
155 GENERATE_DOCSET        = NO
156 DOCSET_FEEDNAME        = "Doxygen generated docs"
157 DOCSET_BUNDLE_ID       = org.doxygen.Project
158 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
159 DOCSET_PUBLISHER_NAME  = Publisher
160 GENERATE_HTMLHELP      = NO
161 CHM_FILE               =
162 HHC_LOCATION           =
163 GENERATE_CHI           = NO
164 CHM_INDEX_ENCODING     =
165 BINARY_TOC             = YES
166 TOC_EXPAND             = YES
167 GENERATE_QHP           = NO
168 QCH_FILE               =
169 QHP_NAMESPACE          = org.doxygen.Project
170 QHP_VIRTUAL_FOLDER     = doc
171 QHP_CUST_FILTER_NAME   =
172 QHP_SECT_FILTER_ATTRS  =
173 QHG_LOCATION           =
174 GENERATE_ECLIPSEHELP   = NO
175 ECLIPSE_DOC_ID         = org.doxygen.Project
176 DISABLE_INDEX          = NO
177 GENERATE_TREEVIEW      = YES
178 ENUM_VALUES_PER_LINE   = 4
179 TREEVIEW_WIDTH         = 250
180 EXT_LINKS_IN_WINDOW    = NO
181 FORMULA_FONTSIZE       = 10
182 FORMULA_TRANSPARENT    = YES
183 USE_MATHJAX            = NO
184 MATHJAX_FORMAT         = HTML-CSS
185 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
186 MATHJAX_EXTENSIONS     =
187 SEARCHENGINE           = YES
188 SERVER_BASED_SEARCH    = NO
189 EXTERNAL_SEARCH        = NO
190 SEARCHENGINE_URL       =
191 SEARCHDATA_FILE        = searchdata.xml
192 EXTERNAL_SEARCH_ID     =
193 EXTRA_SEARCH_MAPPINGS  =
194 #---------------------------------------------------------------------------
195 # configuration options related to the LaTeX output
196 #---------------------------------------------------------------------------
197 GENERATE_LATEX         = NO
198 LATEX_OUTPUT           = latex
199 LATEX_CMD_NAME         = latex
200 MAKEINDEX_CMD_NAME     = makeindex
201 COMPACT_LATEX          = NO
202 PAPER_TYPE             = a4wide
203 EXTRA_PACKAGES         =
204 LATEX_HEADER           =
205 LATEX_FOOTER           =
206 PDF_HYPERLINKS         = NO
207 USE_PDFLATEX           = NO
208 LATEX_BATCHMODE        = NO
209 LATEX_HIDE_INDICES     = NO
210 LATEX_SOURCE_CODE      = NO
211 LATEX_BIB_STYLE        = plain
212 #---------------------------------------------------------------------------
213 # configuration options related to the RTF output
214 #---------------------------------------------------------------------------
215 GENERATE_RTF           = NO
216 RTF_OUTPUT             = rtf
217 COMPACT_RTF            = NO
218 RTF_HYPERLINKS         = NO
219 RTF_STYLESHEET_FILE    =
220 RTF_EXTENSIONS_FILE    =
221 #---------------------------------------------------------------------------
222 # configuration options related to the man page output
223 #---------------------------------------------------------------------------
224 GENERATE_MAN           = NO
225 MAN_OUTPUT             = man
226 MAN_EXTENSION          = .3
227 MAN_LINKS              = NO
228 #---------------------------------------------------------------------------
229 # configuration options related to the XML output
230 #---------------------------------------------------------------------------
231 GENERATE_XML           = YES
232 XML_OUTPUT             = xml
233 #XML_SCHEMA             =
234 #XML_DTD                =
235 XML_PROGRAMLISTING     = YES
236 #---------------------------------------------------------------------------
237 # configuration options for the AutoGen Definitions output
238 #---------------------------------------------------------------------------
239 GENERATE_AUTOGEN_DEF   = NO
240 #---------------------------------------------------------------------------
241 # configuration options related to the Perl module output
242 #---------------------------------------------------------------------------
243 GENERATE_PERLMOD       = NO
244 PERLMOD_LATEX          = NO
245 PERLMOD_PRETTY         = YES
246 PERLMOD_MAKEVAR_PREFIX =
247 #---------------------------------------------------------------------------
248 # Configuration options related to the preprocessor
249 #---------------------------------------------------------------------------
250 ENABLE_PREPROCESSING   = YES
251 MACRO_EXPANSION        = YES
252 EXPAND_ONLY_PREDEF     = NO
253 SEARCH_INCLUDES        = YES
254 INCLUDE_PATH           = @PROJECT_SOURCE_DIR@/src/ModelHighAPI
255 INCLUDE_FILE_PATTERNS  =
256 PREDEFINED = Standard_EXPORT __Standard_API __Draw_API Handle(a):=Handle DEFINE_STANDARD_ALLOC DEFINE_NCOLLECTION_ALLOC DEFINE_STANDARD_HANDLE DEFINE_STANDARD_RTTI
257 EXPAND_AS_DEFINED      =
258 SKIP_FUNCTION_MACROS   = NO
259 #---------------------------------------------------------------------------
260 # Configuration::additions related to external references
261 #---------------------------------------------------------------------------
262 TAGFILES               =
263 GENERATE_TAGFILE       =
264 ALLEXTERNALS           = NO
265 EXTERNAL_GROUPS        = YES
266 PERL_PATH              = /usr/bin/perl
267 #---------------------------------------------------------------------------
268 # Configuration options related to the dot tool
269 #---------------------------------------------------------------------------
270 CLASS_DIAGRAMS         = YES
271 MSCGEN_PATH            =
272 HIDE_UNDOC_RELATIONS   = NO
273 HAVE_DOT               = YES
274 DOT_NUM_THREADS        = 0
275 DOT_FONTNAME           = Arial
276 DOT_FONTSIZE           = 10
277 DOT_FONTPATH           =
278 CLASS_GRAPH            = YES
279 COLLABORATION_GRAPH    = NO
280 GROUP_GRAPHS           = NO
281 UML_LOOK               = NO
282 UML_LIMIT_NUM_FIELDS   = 10
283 TEMPLATE_RELATIONS     = YES
284 INCLUDE_GRAPH          = YES
285 INCLUDED_BY_GRAPH      = NO
286 CALL_GRAPH             = NO
287 CALLER_GRAPH           = NO
288 GRAPHICAL_HIERARCHY    = NO
289 DIRECTORY_GRAPH        = NO
290 DOT_IMAGE_FORMAT       = png
291 INTERACTIVE_SVG        = NO
292 DOT_PATH               =
293 DOTFILE_DIRS           =
294 MSCFILE_DIRS           =
295 DOT_GRAPH_MAX_NODES    = 50
296 MAX_DOT_GRAPH_DEPTH    = 0
297 DOT_TRANSPARENT        = NO
298 DOT_MULTI_TARGETS      = NO
299 GENERATE_LEGEND        = NO
300 DOT_CLEANUP            = YES