]> SALOME platform Git repositories - modules/yacs.git/blob - doc/Doxyfile.in
Salome HOME
0022328: [CEA 942] Worrying traces at YACS launch and SALOME closure
[modules/yacs.git] / doc / Doxyfile.in
1 # Copyright (C) 2006-2013  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.
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.4.2
21 #---------------------------------------------------------------------------
22 # Project related configuration options
23 #---------------------------------------------------------------------------
24 #
25 PROJECT_NAME           = YACS
26 PROJECT_NUMBER         = 0.1
27 OUTPUT_DIRECTORY       = YACS
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        = 
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 DISTRIBUTE_GROUP_DOC   = NO
55 SEPARATE_MEMBER_PAGES  = NO
56 TAB_SIZE               = 8
57 ALIASES                = 
58 OPTIMIZE_OUTPUT_FOR_C  = NO
59 OPTIMIZE_OUTPUT_JAVA   = NO
60 SUBGROUPING            = YES
61 #---------------------------------------------------------------------------
62 # Build related configuration options
63 #---------------------------------------------------------------------------
64 EXTRACT_ALL            = YES
65 EXTRACT_PRIVATE        = YES
66 EXTRACT_STATIC         = YES
67 EXTRACT_LOCAL_CLASSES  = YES
68 EXTRACT_LOCAL_METHODS  = NO
69 HIDE_UNDOC_MEMBERS     = NO
70 HIDE_UNDOC_CLASSES     = NO
71 HIDE_FRIEND_COMPOUNDS  = NO
72 HIDE_IN_BODY_DOCS      = NO
73 INTERNAL_DOCS          = NO
74 CASE_SENSE_NAMES       = YES
75 HIDE_SCOPE_NAMES       = NO
76 SHOW_INCLUDE_FILES     = YES
77 INLINE_INFO            = YES
78 SORT_MEMBER_DOCS       = YES
79 SORT_BRIEF_DOCS        = NO
80 SORT_BY_SCOPE_NAME     = NO
81 GENERATE_TODOLIST      = YES
82 GENERATE_TESTLIST      = YES
83 GENERATE_BUGLIST       = YES
84 GENERATE_DEPRECATEDLIST= YES
85 ENABLED_SECTIONS       = 
86 MAX_INITIALIZER_LINES  = 30
87 SHOW_USED_FILES        = YES
88 SHOW_DIRECTORIES       = YES
89 FILE_VERSION_FILTER    = 
90 #---------------------------------------------------------------------------
91 # configuration options related to warning and progress messages
92 #---------------------------------------------------------------------------
93 QUIET                  = NO
94 WARNINGS               = YES
95 WARN_IF_UNDOCUMENTED   = YES
96 WARN_IF_DOC_ERROR      = YES
97 WARN_NO_PARAMDOC       = NO
98 WARN_FORMAT            = "$file:$line: $text"
99 WARN_LOGFILE           = 
100 #---------------------------------------------------------------------------
101 # configuration options related to the input files
102 #---------------------------------------------------------------------------
103 INPUT                  =  \
104    @CMAKE_SOURCE_DIR@/doc/ref      \
105    @CMAKE_SOURCE_DIR@/idl \
106    @CMAKE_SOURCE_DIR@/src/bases \
107    @CMAKE_SOURCE_DIR@/src/engine \
108    @CMAKE_SOURCE_DIR@/src/runtime \
109    @CMAKE_SOURCE_DIR@/src/yacsloader \
110    @CMAKE_SOURCE_DIR@/src/yacsorb \
111    @CMAKE_SOURCE_DIR@/src/hmi \
112    @CMAKE_SOURCE_DIR@/src/salomewrap \
113    @CMAKE_SOURCE_DIR@/src/genericgui \
114    @CMAKE_SOURCE_DIR@/src/salomegui \
115    @CMAKE_SOURCE_DIR@/src/salomewrap \
116    @CMAKE_SOURCE_DIR@/src/pyqt
117
118 FILE_PATTERNS          = *.c \
119                          *.cc \
120                          *.cxx \
121                          *.cpp \
122                          *.c++ \
123                          *.py \
124                          *.d \
125                          *.java \
126                          *.ii \
127                          *.ixx \
128                          *.ipp \
129                          *.i++ \
130                          *.inl \
131                          *.h \
132                          *.hh \
133                          *.hxx \
134                          *.hpp \
135                          *.h++ \
136                          *.idl \
137                          *.odl \
138                          *.cs \
139                          *.php \
140                          *.php3 \
141                          *.inc \
142                          *.m \
143                          *.mm \
144                          *.dox \
145                          *.C \
146                          *.CC \
147                          *.C++ \
148                          *.II \
149                          *.I++ \
150                          *.H \
151                          *.HH \
152                          *.H++ \
153                          *.CS \
154                          *.PHP \
155                          *.PHP3 \
156                          *.M \
157                          *.MM
158 RECURSIVE              = YES
159 EXCLUDE                = @CMAKE_SOURCE_DIR@/src/yacsloader/tools 
160 EXCLUDE_SYMLINKS       = NO
161 EXCLUDE_PATTERNS       = */Test/*
162 EXAMPLE_PATH           = 
163 EXAMPLE_PATTERNS       = *
164 EXAMPLE_RECURSIVE      = NO
165 IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc
166 INPUT_FILTER           = 
167 FILTER_PATTERNS        = 
168 FILTER_SOURCE_FILES    = NO
169 #---------------------------------------------------------------------------
170 # configuration options related to source browsing
171 #---------------------------------------------------------------------------
172 SOURCE_BROWSER         = YES
173 INLINE_SOURCES         = YES
174 STRIP_CODE_COMMENTS    = YES
175 REFERENCED_BY_RELATION = YES
176 REFERENCES_RELATION    = YES
177 VERBATIM_HEADERS       = YES
178 #---------------------------------------------------------------------------
179 # configuration options related to the alphabetical class index
180 #---------------------------------------------------------------------------
181 ALPHABETICAL_INDEX     = YES
182 COLS_IN_ALPHA_INDEX    = 2
183 IGNORE_PREFIX          = 
184 #---------------------------------------------------------------------------
185 # configuration options related to the HTML output
186 #---------------------------------------------------------------------------
187 GENERATE_HTML          = YES
188 HTML_OUTPUT            = htmldev
189 HTML_FILE_EXTENSION    = .html
190 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/sources/header.html
191 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/sources/footer.html
192 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/sources/salome_extra.css
193 HTML_ALIGN_MEMBERS     = YES
194 GENERATE_HTMLHELP      = NO
195 CHM_FILE               = 
196 HHC_LOCATION           = 
197 GENERATE_CHI           = NO
198 BINARY_TOC             = NO
199 TOC_EXPAND             = NO
200 DISABLE_INDEX          = NO
201 ENUM_VALUES_PER_LINE   = 4
202 GENERATE_TREEVIEW      = YES
203 TREEVIEW_WIDTH         = 250
204 #---------------------------------------------------------------------------
205 # configuration options related to the LaTeX output
206 #---------------------------------------------------------------------------
207 GENERATE_LATEX         = NO
208 LATEX_OUTPUT           = latex
209 LATEX_CMD_NAME         = latex
210 MAKEINDEX_CMD_NAME     = makeindex
211 COMPACT_LATEX          = NO
212 PAPER_TYPE             = a4wide
213 EXTRA_PACKAGES         = 
214 LATEX_HEADER           = 
215 PDF_HYPERLINKS         = NO
216 USE_PDFLATEX           = NO
217 LATEX_BATCHMODE        = NO
218 LATEX_HIDE_INDICES     = NO
219 #---------------------------------------------------------------------------
220 # configuration options related to the RTF output
221 #---------------------------------------------------------------------------
222 GENERATE_RTF           = NO
223 RTF_OUTPUT             = rtf
224 COMPACT_RTF            = NO
225 RTF_HYPERLINKS         = NO
226 RTF_STYLESHEET_FILE    = 
227 RTF_EXTENSIONS_FILE    = 
228 #---------------------------------------------------------------------------
229 # configuration options related to the man page output
230 #---------------------------------------------------------------------------
231 GENERATE_MAN           = NO
232 MAN_OUTPUT             = man
233 MAN_EXTENSION          = .3
234 MAN_LINKS              = NO
235 #---------------------------------------------------------------------------
236 # configuration options related to the XML output
237 #---------------------------------------------------------------------------
238 GENERATE_XML           = NO
239 XML_OUTPUT             = xml
240 XML_SCHEMA             = 
241 XML_DTD                = 
242 XML_PROGRAMLISTING     = YES
243 #---------------------------------------------------------------------------
244 # configuration options for the AutoGen Definitions output
245 #---------------------------------------------------------------------------
246 GENERATE_AUTOGEN_DEF   = NO
247 #---------------------------------------------------------------------------
248 # configuration options related to the Perl module output
249 #---------------------------------------------------------------------------
250 GENERATE_PERLMOD       = NO
251 PERLMOD_LATEX          = NO
252 PERLMOD_PRETTY         = YES
253 PERLMOD_MAKEVAR_PREFIX = 
254 #---------------------------------------------------------------------------
255 # Configuration options related to the preprocessor   
256 #---------------------------------------------------------------------------
257 ENABLE_PREPROCESSING   = YES
258 MACRO_EXPANSION        = NO
259 EXPAND_ONLY_PREDEF     = NO
260 SEARCH_INCLUDES        = YES
261 INCLUDE_PATH           = 
262 INCLUDE_FILE_PATTERNS  = 
263 PREDEFINED             = 
264 EXPAND_AS_DEFINED      = 
265 SKIP_FUNCTION_MACROS   = YES
266 #---------------------------------------------------------------------------
267 # Configuration::additions related to external references   
268 #---------------------------------------------------------------------------
269 TAGFILES               = 
270 GENERATE_TAGFILE       = 
271 ALLEXTERNALS           = NO
272 EXTERNAL_GROUPS        = YES
273 PERL_PATH              = /usr/bin/perl
274 #---------------------------------------------------------------------------
275 # Configuration options related to the dot tool   
276 #---------------------------------------------------------------------------
277 CLASS_DIAGRAMS         = YES
278 HIDE_UNDOC_RELATIONS   = NO
279 HAVE_DOT               = YES
280 CLASS_GRAPH            = YES
281 COLLABORATION_GRAPH    = YES
282 GROUP_GRAPHS           = YES
283 UML_LOOK               = NO
284 TEMPLATE_RELATIONS     = YES
285 INCLUDE_GRAPH          = YES
286 INCLUDED_BY_GRAPH      = YES
287 CALL_GRAPH             = NO
288 GRAPHICAL_HIERARCHY    = YES
289 DIRECTORY_GRAPH        = YES
290 DOT_IMAGE_FORMAT       = png
291 DOT_PATH               = 
292 DOTFILE_DIRS           = 
293 MAX_DOT_GRAPH_WIDTH    = 1024
294 MAX_DOT_GRAPH_HEIGHT   = 1024
295 MAX_DOT_GRAPH_DEPTH    = 1000
296 DOT_TRANSPARENT        = NO
297 DOT_MULTI_TARGETS      = NO
298 GENERATE_LEGEND        = YES
299 DOT_CLEANUP            = YES
300 #---------------------------------------------------------------------------
301 # Configuration::additions related to the search engine   
302 #---------------------------------------------------------------------------
303 SEARCHENGINE           = NO