Salome HOME
Merge from V6_main 01/04/2013
[modules/geom.git] / doc / salome / tui / doxyfile.in
1 # Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
2 #
3 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 #
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.
10 #
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.
15 #
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
19 #
20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 #
22
23 # Doxyfile 1.4.6
24
25 #---------------------------------------------------------------------------
26 # Project related configuration options
27 #---------------------------------------------------------------------------
28 PROJECT_NAME           = "SALOME Geometry Developer"
29 PROJECT_NUMBER         = 
30 OUTPUT_DIRECTORY       = GEOM
31 CREATE_SUBDIRS         = NO
32 OUTPUT_LANGUAGE        = English
33 USE_WINDOWS_ENCODING   = NO
34 BRIEF_MEMBER_DESC      = YES
35 REPEAT_BRIEF           = NO
36 ABBREVIATE_BRIEF       = 
37 ALWAYS_DETAILED_SEC    = YES
38 INLINE_INHERITED_MEMB  = YES
39 FULL_PATH_NAMES        = YES
40 STRIP_FROM_PATH        = @top_srcdir@ @top_builddir@
41 STRIP_FROM_INC_PATH    = 
42 SHORT_NAMES            = NO
43 JAVADOC_AUTOBRIEF      = YES
44 MULTILINE_CPP_IS_BRIEF = NO
45 DETAILS_AT_TOP         = NO
46 INHERIT_DOCS           = YES
47 SEPARATE_MEMBER_PAGES  = NO
48 TAB_SIZE               = 5
49 ALIASES                = 
50 OPTIMIZE_OUTPUT_FOR_C  = YES
51 OPTIMIZE_OUTPUT_JAVA   = YES
52 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
53 DISTRIBUTE_GROUP_DOC   = NO
54 SUBGROUPING            = YES
55
56 #---------------------------------------------------------------------------
57 # Build related configuration options
58 #---------------------------------------------------------------------------
59 EXTRACT_ALL            = YES
60 EXTRACT_PRIVATE        = YES
61 EXTRACT_STATIC         = YES
62 EXTRACT_LOCAL_CLASSES  = YES
63 EXTRACT_LOCAL_METHODS  = NO
64 HIDE_UNDOC_MEMBERS     = NO
65 HIDE_UNDOC_CLASSES     = NO
66 HIDE_FRIEND_COMPOUNDS  = NO
67 HIDE_IN_BODY_DOCS      = NO
68 INTERNAL_DOCS          = YES
69 CASE_SENSE_NAMES       = YES
70 HIDE_SCOPE_NAMES       = NO
71 SHOW_INCLUDE_FILES     = YES
72 INLINE_INFO            = YES
73 SORT_MEMBER_DOCS       = NO
74 SORT_BRIEF_DOCS        = NO
75 SORT_BY_SCOPE_NAME     = NO
76 GENERATE_TODOLIST      = YES
77 GENERATE_TESTLIST      = YES
78 GENERATE_BUGLIST       = YES
79 GENERATE_DEPRECATEDLIST= YES
80 ENABLED_SECTIONS       = 
81 MAX_INITIALIZER_LINES  = 25
82 SHOW_USED_FILES        = NO
83 SHOW_DIRECTORIES       = NO
84 FILE_VERSION_FILTER    = 
85
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           =
96
97 #---------------------------------------------------------------------------
98 # configuration options related to the input files
99 #---------------------------------------------------------------------------
100 INPUT                  = @top_srcdir@/src \
101                          ./geompy.py \
102                          @top_srcdir@/bin \
103                          @top_srcdir@/idl \
104                          @top_builddir@/bin \
105                          @srcdir@/input
106 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
107 RECURSIVE              = YES
108 EXCLUDE                = @top_srcdir@/src/GEOM_SWIG/geompy.py \
109                          @top_srcdir@/src/GEOM_SWIG/geompyDC.py
110 EXCLUDE_SYMLINKS       = NO
111 EXCLUDE_PATTERNS       = 
112 EXAMPLE_PATH           = 
113 EXAMPLE_PATTERNS       = 
114 EXAMPLE_RECURSIVE      = NO
115 IMAGE_PATH             = @srcdir@/images
116 INPUT_FILTER           = 
117 FILTER_PATTERNS        = 
118 FILTER_SOURCE_FILES    = YES
119
120 #---------------------------------------------------------------------------
121 # configuration options related to source browsing
122 #---------------------------------------------------------------------------
123 SOURCE_BROWSER         = NO
124 INLINE_SOURCES         = NO
125 STRIP_CODE_COMMENTS    = YES
126 REFERENCED_BY_RELATION = NO
127 REFERENCES_RELATION    = YES
128 USE_HTAGS              = NO
129 VERBATIM_HEADERS       = YES
130
131 #---------------------------------------------------------------------------
132 # configuration options related to the alphabetical class index
133 #---------------------------------------------------------------------------
134 ALPHABETICAL_INDEX     = YES
135 COLS_IN_ALPHA_INDEX    = 3
136 IGNORE_PREFIX          = 
137
138 #---------------------------------------------------------------------------
139 # configuration options related to the HTML output
140 #---------------------------------------------------------------------------
141 GENERATE_HTML          = YES
142 HTML_OUTPUT            = .
143 HTML_FILE_EXTENSION    = .html
144 HTML_HEADER            = @builddir@/static/header.html
145 HTML_FOOTER            = @srcdir@/static/footer.html
146 HTML_STYLESHEET        = @srcdir@/static/doxygen.css
147 HTML_ALIGN_MEMBERS     = YES
148 GENERATE_HTMLHELP      = NO
149 CHM_FILE               = 
150 HHC_LOCATION           = 
151 GENERATE_CHI           = NO
152 BINARY_TOC             = YES
153 TOC_EXPAND             = YES
154 DISABLE_INDEX          = NO
155 ENUM_VALUES_PER_LINE   = 4
156 GENERATE_TREEVIEW      = NO
157 TREEVIEW_WIDTH         = 250
158
159 #---------------------------------------------------------------------------
160 # configuration options related to the LaTeX output
161 #---------------------------------------------------------------------------
162 GENERATE_LATEX         = NO
163 LATEX_OUTPUT           = latex
164 LATEX_CMD_NAME         = latex
165 MAKEINDEX_CMD_NAME     = makeindex
166 COMPACT_LATEX          = NO
167 PAPER_TYPE             = a4wide
168 EXTRA_PACKAGES         = 
169 LATEX_HEADER           = 
170 PDF_HYPERLINKS         = NO
171 USE_PDFLATEX           = NO
172 LATEX_BATCHMODE        = NO
173 LATEX_HIDE_INDICES     = NO
174
175 #---------------------------------------------------------------------------
176 # configuration options related to the RTF output
177 #---------------------------------------------------------------------------
178 GENERATE_RTF           = NO
179 RTF_OUTPUT             = rtf
180 COMPACT_RTF            = NO
181 RTF_HYPERLINKS         = NO
182 RTF_STYLESHEET_FILE    = 
183 RTF_EXTENSIONS_FILE    = 
184
185 #---------------------------------------------------------------------------
186 # configuration options related to the man page output
187 #---------------------------------------------------------------------------
188 GENERATE_MAN           = NO
189 MAN_OUTPUT             = man
190 MAN_EXTENSION          = .3
191 MAN_LINKS              = NO
192
193 #---------------------------------------------------------------------------
194 # configuration options related to the XML output
195 #---------------------------------------------------------------------------
196 GENERATE_XML           = NO
197 XML_OUTPUT             = xml
198 XML_SCHEMA             = 
199 XML_DTD                = 
200 XML_PROGRAMLISTING     = YES
201
202 #---------------------------------------------------------------------------
203 # configuration options for the AutoGen Definitions output
204 #---------------------------------------------------------------------------
205 GENERATE_AUTOGEN_DEF   = NO
206
207 #---------------------------------------------------------------------------
208 # configuration options related to the Perl module output
209 #---------------------------------------------------------------------------
210 GENERATE_PERLMOD       = NO
211 PERLMOD_LATEX          = NO
212 PERLMOD_PRETTY         = YES
213 PERLMOD_MAKEVAR_PREFIX = 
214
215 #---------------------------------------------------------------------------
216 # Configuration options related to the preprocessor   
217 #---------------------------------------------------------------------------
218 ENABLE_PREPROCESSING   = YES
219 MACRO_EXPANSION        = NO
220 EXPAND_ONLY_PREDEF     = NO
221 SEARCH_INCLUDES        = YES
222 INCLUDE_PATH           = 
223 INCLUDE_FILE_PATTERNS  = 
224 PREDEFINED             = 
225 EXPAND_AS_DEFINED      = 
226 SKIP_FUNCTION_MACROS   = NO
227
228 #---------------------------------------------------------------------------
229 # Configuration::additions related to external references   
230 #---------------------------------------------------------------------------
231 TAGFILES               = 
232 GENERATE_TAGFILE       = 
233 ALLEXTERNALS           = NO
234 EXTERNAL_GROUPS        = YES
235 PERL_PATH              = /usr/bin/perl
236
237 #---------------------------------------------------------------------------
238 # Configuration options related to the dot tool   
239 #---------------------------------------------------------------------------
240 CLASS_DIAGRAMS         = YES
241 HIDE_UNDOC_RELATIONS   = NO
242 HAVE_DOT               = YES
243 CLASS_GRAPH            = YES
244 COLLABORATION_GRAPH    = NO
245 GROUP_GRAPHS           = NO
246 UML_LOOK               = NO
247 TEMPLATE_RELATIONS     = YES
248 INCLUDE_GRAPH          = YES
249 INCLUDED_BY_GRAPH      = NO
250 CALL_GRAPH             = NO
251 GRAPHICAL_HIERARCHY    = YES
252 DIRECTORY_GRAPH        = YES
253 DOT_IMAGE_FORMAT       = png
254 DOT_FONTNAME           = Arial
255 DOT_PATH               = 
256 DOTFILE_DIRS           = 
257 MAX_DOT_GRAPH_WIDTH    = 1024
258 MAX_DOT_GRAPH_HEIGHT   = 1200
259 MAX_DOT_GRAPH_DEPTH    = 0
260 DOT_TRANSPARENT        = NO
261 DOT_MULTI_TARGETS      = NO
262 GENERATE_LEGEND        = NO
263 DOT_CLEANUP            = YES
264
265 #---------------------------------------------------------------------------
266 # Configuration::additions related to the search engine   
267 #---------------------------------------------------------------------------
268 SEARCHENGINE           = NO