Salome HOME
optparse => argparse
[modules/hexablock.git] / Doxyfile
1 # Copyright (C) 2009-2016  CEA/DEN, EDF R&D
2 #
3 # This library is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU Lesser General Public
5 # License as published by the Free Software Foundation; either
6 # version 2.1 of the License, or (at your option) any later version.
7 #
8 # This library is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 # Lesser General Public License for more details.
12 #
13 # You should have received a copy of the GNU Lesser General Public
14 # License along with this library; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 #
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 #
19
20 # Doxyfile 1.5.1-KDevelop
21
22 #---------------------------------------------------------------------------
23 # Project related configuration options
24 #---------------------------------------------------------------------------
25 PROJECT_NAME           = HEXA
26 PROJECT_NUMBER         = [5.1.2]
27 OUTPUT_DIRECTORY       = 
28 CREATE_SUBDIRS         = NO
29 OUTPUT_LANGUAGE        = English
30 USE_WINDOWS_ENCODING   = NO
31 BRIEF_MEMBER_DESC      = YES
32 REPEAT_BRIEF           = YES
33 ABBREVIATE_BRIEF       = "The $name class" \
34                          "The $name widget" \
35                          "The $name file" \
36                          is \
37                          provides \
38                          specifies \
39                          contains \
40                          represents \
41                          a \
42                          an \
43                          the
44 ALWAYS_DETAILED_SEC    = NO
45 INLINE_INHERITED_MEMB  = NO
46 FULL_PATH_NAMES        = YES
47 STRIP_FROM_PATH        = /home/bphetsar/
48 STRIP_FROM_INC_PATH    = 
49 SHORT_NAMES            = NO
50 JAVADOC_AUTOBRIEF      = NO
51 MULTILINE_CPP_IS_BRIEF = NO
52 DETAILS_AT_TOP         = NO
53 INHERIT_DOCS           = YES
54 SEPARATE_MEMBER_PAGES  = NO
55 TAB_SIZE               = 8
56 ALIASES                = 
57 OPTIMIZE_OUTPUT_FOR_C  = NO
58 OPTIMIZE_OUTPUT_JAVA   = NO
59 BUILTIN_STL_SUPPORT    = NO
60 DISTRIBUTE_GROUP_DOC   = NO
61 SUBGROUPING            = YES
62 #---------------------------------------------------------------------------
63 # Build related configuration options
64 #---------------------------------------------------------------------------
65 EXTRACT_ALL            = NO
66 EXTRACT_PRIVATE        = NO
67 EXTRACT_STATIC         = NO
68 EXTRACT_LOCAL_CLASSES  = YES
69 EXTRACT_LOCAL_METHODS  = 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       = YES
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_BY_SCOPE_NAME     = NO
82 GENERATE_TODOLIST      = YES
83 GENERATE_TESTLIST      = YES
84 GENERATE_BUGLIST       = YES
85 GENERATE_DEPRECATEDLIST= YES
86 ENABLED_SECTIONS       = 
87 MAX_INITIALIZER_LINES  = 30
88 SHOW_USED_FILES        = YES
89 SHOW_DIRECTORIES       = NO
90 FILE_VERSION_FILTER    = 
91 #---------------------------------------------------------------------------
92 # configuration options related to warning and progress messages
93 #---------------------------------------------------------------------------
94 QUIET                  = NO
95 WARNINGS               = YES
96 WARN_IF_UNDOCUMENTED   = YES
97 WARN_IF_DOC_ERROR      = YES
98 WARN_NO_PARAMDOC       = NO
99 WARN_FORMAT            = "$file:$line: $text"
100 WARN_LOGFILE           = 
101 #---------------------------------------------------------------------------
102 # configuration options related to the input files
103 #---------------------------------------------------------------------------
104 INPUT                  = /export/home/bphetsar/PR_HEX/HEXA_SRC
105 FILE_PATTERNS          = *.c \
106                          *.cc \
107                          *.cxx \
108                          *.cpp \
109                          *.c++ \
110                          *.d \
111                          *.java \
112                          *.ii \
113                          *.ixx \
114                          *.ipp \
115                          *.i++ \
116                          *.inl \
117                          *.h \
118                          *.hh \
119                          *.hxx \
120                          *.hpp \
121                          *.h++ \
122                          *.idl \
123                          *.odl \
124                          *.cs \
125                          *.php \
126                          *.php3 \
127                          *.inc \
128                          *.m \
129                          *.mm \
130                          *.dox \
131                          *.py \
132                          *.C \
133                          *.CC \
134                          *.C++ \
135                          *.II \
136                          *.I++ \
137                          *.H \
138                          *.HH \
139                          *.H++ \
140                          *.CS \
141                          *.PHP \
142                          *.PHP3 \
143                          *.M \
144                          *.MM \
145                          *.PY \
146                          *.C \
147                          *.H \
148                          *.tlh \
149                          *.diff \
150                          *.patch \
151                          *.moc \
152                          *.xpm \
153                          *.dox
154 RECURSIVE              = yes
155 EXCLUDE                = 
156 EXCLUDE_SYMLINKS       = NO
157 EXCLUDE_PATTERNS       = 
158 EXAMPLE_PATH           = 
159 EXAMPLE_PATTERNS       = *
160 EXAMPLE_RECURSIVE      = NO
161 IMAGE_PATH             = 
162 INPUT_FILTER           = 
163 FILTER_PATTERNS        = 
164 FILTER_SOURCE_FILES    = NO
165 #---------------------------------------------------------------------------
166 # configuration options related to source browsing
167 #---------------------------------------------------------------------------
168 SOURCE_BROWSER         = NO
169 INLINE_SOURCES         = NO
170 STRIP_CODE_COMMENTS    = YES
171 REFERENCED_BY_RELATION = YES
172 REFERENCES_RELATION    = YES
173 REFERENCES_LINK_SOURCE = YES
174 USE_HTAGS              = NO
175 VERBATIM_HEADERS       = YES
176 #---------------------------------------------------------------------------
177 # configuration options related to the alphabetical class index
178 #---------------------------------------------------------------------------
179 ALPHABETICAL_INDEX     = NO
180 COLS_IN_ALPHA_INDEX    = 5
181 IGNORE_PREFIX          = 
182 #---------------------------------------------------------------------------
183 # configuration options related to the HTML output
184 #---------------------------------------------------------------------------
185 GENERATE_HTML          = YES
186 HTML_OUTPUT            = html
187 HTML_FILE_EXTENSION    = .html
188 HTML_HEADER            = 
189 HTML_FOOTER            = 
190 HTML_STYLESHEET        = 
191 HTML_ALIGN_MEMBERS     = YES
192 GENERATE_HTMLHELP      = NO
193 CHM_FILE               = 
194 HHC_LOCATION           = 
195 GENERATE_CHI           = NO
196 BINARY_TOC             = NO
197 TOC_EXPAND             = NO
198 DISABLE_INDEX          = NO
199 ENUM_VALUES_PER_LINE   = 4
200 GENERATE_TREEVIEW      = NO
201 TREEVIEW_WIDTH         = 250
202 #---------------------------------------------------------------------------
203 # configuration options related to the LaTeX output
204 #---------------------------------------------------------------------------
205 GENERATE_LATEX         = YES
206 LATEX_OUTPUT           = latex
207 LATEX_CMD_NAME         = latex
208 MAKEINDEX_CMD_NAME     = makeindex
209 COMPACT_LATEX          = NO
210 PAPER_TYPE             = a4wide
211 EXTRA_PACKAGES         = 
212 LATEX_HEADER           = 
213 PDF_HYPERLINKS         = NO
214 USE_PDFLATEX           = NO
215 LATEX_BATCHMODE        = NO
216 LATEX_HIDE_INDICES     = NO
217 #---------------------------------------------------------------------------
218 # configuration options related to the RTF output
219 #---------------------------------------------------------------------------
220 GENERATE_RTF           = NO
221 RTF_OUTPUT             = rtf
222 COMPACT_RTF            = NO
223 RTF_HYPERLINKS         = NO
224 RTF_STYLESHEET_FILE    = 
225 RTF_EXTENSIONS_FILE    = 
226 #---------------------------------------------------------------------------
227 # configuration options related to the man page output
228 #---------------------------------------------------------------------------
229 GENERATE_MAN           = NO
230 MAN_OUTPUT             = man
231 MAN_EXTENSION          = .3
232 MAN_LINKS              = NO
233 #---------------------------------------------------------------------------
234 # configuration options related to the XML output
235 #---------------------------------------------------------------------------
236 GENERATE_XML           = yes
237 XML_OUTPUT             = xml
238 XML_SCHEMA             = 
239 XML_DTD                = 
240 XML_PROGRAMLISTING     = YES
241 #---------------------------------------------------------------------------
242 # configuration options for the AutoGen Definitions output
243 #---------------------------------------------------------------------------
244 GENERATE_AUTOGEN_DEF   = NO
245 #---------------------------------------------------------------------------
246 # configuration options related to the Perl module output
247 #---------------------------------------------------------------------------
248 GENERATE_PERLMOD       = NO
249 PERLMOD_LATEX          = NO
250 PERLMOD_PRETTY         = YES
251 PERLMOD_MAKEVAR_PREFIX = 
252 #---------------------------------------------------------------------------
253 # Configuration options related to the preprocessor   
254 #---------------------------------------------------------------------------
255 ENABLE_PREPROCESSING   = YES
256 MACRO_EXPANSION        = NO
257 EXPAND_ONLY_PREDEF     = NO
258 SEARCH_INCLUDES        = YES
259 INCLUDE_PATH           = 
260 INCLUDE_FILE_PATTERNS  = 
261 PREDEFINED             = 
262 EXPAND_AS_DEFINED      = 
263 SKIP_FUNCTION_MACROS   = YES
264 #---------------------------------------------------------------------------
265 # Configuration::additions related to external references   
266 #---------------------------------------------------------------------------
267 TAGFILES               = 
268 GENERATE_TAGFILE       = HEXA.tag
269 ALLEXTERNALS           = NO
270 EXTERNAL_GROUPS        = YES
271 PERL_PATH              = /usr/bin/perl
272 #---------------------------------------------------------------------------
273 # Configuration options related to the dot tool   
274 #---------------------------------------------------------------------------
275 CLASS_DIAGRAMS         = YES
276 HIDE_UNDOC_RELATIONS   = YES
277 HAVE_DOT               = NO
278 CLASS_GRAPH            = YES
279 COLLABORATION_GRAPH    = YES
280 GROUP_GRAPHS           = YES
281 UML_LOOK               = NO
282 TEMPLATE_RELATIONS     = NO
283 INCLUDE_GRAPH          = YES
284 INCLUDED_BY_GRAPH      = YES
285 CALL_GRAPH             = NO
286 CALLER_GRAPH           = NO
287 GRAPHICAL_HIERARCHY    = YES
288 DIRECTORY_GRAPH        = YES
289 DOT_IMAGE_FORMAT       = png
290 DOT_PATH               = 
291 DOTFILE_DIRS           = 
292 MAX_DOT_GRAPH_WIDTH    = 1024
293 MAX_DOT_GRAPH_HEIGHT   = 1024
294 MAX_DOT_GRAPH_DEPTH    = 1000
295 DOT_TRANSPARENT        = NO
296 DOT_MULTI_TARGETS      = NO
297 GENERATE_LEGEND        = YES
298 DOT_CLEANUP            = YES
299 #---------------------------------------------------------------------------
300 # Configuration::additions related to the search engine   
301 #---------------------------------------------------------------------------
302 SEARCHENGINE           = NO