Salome HOME
Update version name to 3.1.0
[modules/kernel.git] / doc / salome / tui / KERNEL / doxyfile
1 # Doxyfile 1.3-rc1
2
3 #---------------------------------------------------------------------------
4 # General configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = "SALOME v.3.1.0"
7 PROJECT_NUMBER         = id#1.1
8 OUTPUT_DIRECTORY       = ../
9 OUTPUT_LANGUAGE        = English
10 EXTRACT_ALL            = YES
11 EXTRACT_PRIVATE        = YES
12 EXTRACT_STATIC         = YES
13 EXTRACT_LOCAL_CLASSES  = YES
14 HIDE_UNDOC_MEMBERS     = NO
15 HIDE_UNDOC_CLASSES     = NO
16 HIDE_FRIEND_COMPOUNDS  = NO
17 HIDE_IN_BODY_DOCS      = NO
18 BRIEF_MEMBER_DESC      = YES
19 REPEAT_BRIEF           = NO
20 ALWAYS_DETAILED_SEC    = YES
21 INLINE_INHERITED_MEMB  = YES
22 FULL_PATH_NAMES        = NO
23 STRIP_FROM_PATH        = 
24 INTERNAL_DOCS          = YES
25 CASE_SENSE_NAMES       = YES
26 SHORT_NAMES            = NO
27 HIDE_SCOPE_NAMES       = NO
28 VERBATIM_HEADERS       = YES
29 SHOW_INCLUDE_FILES     = YES
30 JAVADOC_AUTOBRIEF      = YES
31 MULTILINE_CPP_IS_BRIEF = NO
32 DETAILS_AT_TOP         = NO
33 INHERIT_DOCS           = YES
34 INLINE_INFO            = YES
35 SORT_MEMBER_DOCS       = NO
36 DISTRIBUTE_GROUP_DOC   = NO
37 TAB_SIZE               = 5
38 GENERATE_TODOLIST      = YES
39 GENERATE_TESTLIST      = YES
40 GENERATE_BUGLIST       = YES
41 GENERATE_DEPRECATEDLIST= YES
42 ALIASES                = 
43 ENABLED_SECTIONS       = 
44 MAX_INITIALIZER_LINES  = 25
45 OPTIMIZE_OUTPUT_FOR_C  = YES
46 OPTIMIZE_OUTPUT_JAVA   = YES
47 SHOW_USED_FILES        = NO
48 #---------------------------------------------------------------------------
49 # configuration options related to warning and progress messages
50 #---------------------------------------------------------------------------
51 QUIET                  = NO
52 WARNINGS               = YES
53 WARN_IF_UNDOCUMENTED   = YES
54 WARN_FORMAT            = "$file:$line: $text"
55 WARN_LOGFILE           = log.txt
56 #---------------------------------------------------------------------------
57 # configuration options related to the input files
58 #---------------------------------------------------------------------------
59 INPUT                  = ../../../share/salome/idl/SALOME_ModuleCatalog.idl \
60                          ../../../share/salome/idl/SALOMEDS.idl \
61                          ../../../share/salome/idl/SALOME_Exception.idl \
62                          ../../../share/salome/idl/SALOMEDS_Attributes.idl \
63                          ../../../share/salome/idl/SALOME_Component.idl \
64                          ../../../share/salome/src/LifeCycleCORBA/SALOME_LifeCycleCORBA.hxx \
65                          ../../../share/salome/src/NamingService/SALOME_NamingService.hxx \
66                          ../../../share/salome/src/NamingService/SALOME_NamingService.cxx \
67                          ../../../share/salome/src/LifeCycleCORBA/SALOME_LifeCycleCORBA.cxx
68 FILE_PATTERNS          = 
69 RECURSIVE              = NO
70 EXCLUDE                = 
71 EXCLUDE_SYMLINKS       = NO
72 EXCLUDE_PATTERNS       = 
73 EXAMPLE_PATH           = 
74 EXAMPLE_PATTERNS       = 
75 EXAMPLE_RECURSIVE      = NO
76 IMAGE_PATH             = sources/
77 INPUT_FILTER           = 
78 FILTER_SOURCE_FILES    = YES
79 #---------------------------------------------------------------------------
80 # configuration options related to source browsing
81 #---------------------------------------------------------------------------
82 SOURCE_BROWSER         = NO
83 INLINE_SOURCES         = NO
84 STRIP_CODE_COMMENTS    = YES
85 REFERENCED_BY_RELATION = NO
86 REFERENCES_RELATION    = YES
87 #---------------------------------------------------------------------------
88 # configuration options related to the alphabetical class index
89 #---------------------------------------------------------------------------
90 ALPHABETICAL_INDEX     = NO
91 COLS_IN_ALPHA_INDEX    = 5
92 IGNORE_PREFIX          = 
93 #---------------------------------------------------------------------------
94 # configuration options related to the HTML output
95 #---------------------------------------------------------------------------
96 GENERATE_HTML          = YES
97 HTML_OUTPUT            = KERNEL
98 HTML_FILE_EXTENSION    = .html
99 HTML_HEADER            = sources/myheader.html
100 HTML_FOOTER            = 
101 HTML_STYLESHEET        = 
102 HTML_ALIGN_MEMBERS     = YES
103 GENERATE_HTMLHELP      = NO
104 CHM_FILE               = 
105 HHC_LOCATION           = 
106 GENERATE_CHI           = NO
107 BINARY_TOC             = YES
108 TOC_EXPAND             = YES
109 DISABLE_INDEX          = YES
110 ENUM_VALUES_PER_LINE   = 4
111 GENERATE_TREEVIEW      = YES
112 TREEVIEW_WIDTH         = 250
113 #---------------------------------------------------------------------------
114 # configuration options related to the LaTeX output
115 #---------------------------------------------------------------------------
116 GENERATE_LATEX         = NO
117 LATEX_OUTPUT           = latex
118 LATEX_CMD_NAME         = latex
119 MAKEINDEX_CMD_NAME     = makeindex
120 COMPACT_LATEX          = NO
121 PAPER_TYPE             = a4wide
122 EXTRA_PACKAGES         = 
123 LATEX_HEADER           = 
124 PDF_HYPERLINKS         = NO
125 USE_PDFLATEX           = NO
126 LATEX_BATCHMODE        = NO
127 #---------------------------------------------------------------------------
128 # configuration options related to the RTF output
129 #---------------------------------------------------------------------------
130 GENERATE_RTF           = NO
131 RTF_OUTPUT             = rtf
132 COMPACT_RTF            = NO
133 RTF_HYPERLINKS         = NO
134 RTF_STYLESHEET_FILE    = 
135 RTF_EXTENSIONS_FILE    = 
136 #---------------------------------------------------------------------------
137 # configuration options related to the man page output
138 #---------------------------------------------------------------------------
139 GENERATE_MAN           = NO
140 MAN_OUTPUT             = man
141 MAN_EXTENSION          = .3
142 MAN_LINKS              = NO
143 #---------------------------------------------------------------------------
144 # configuration options related to the XML output
145 #---------------------------------------------------------------------------
146 GENERATE_XML           = NO
147 XML_SCHEMA             = 
148 XML_DTD                = 
149 #---------------------------------------------------------------------------
150 # configuration options for the AutoGen Definitions output
151 #---------------------------------------------------------------------------
152 GENERATE_AUTOGEN_DEF   = NO
153 #---------------------------------------------------------------------------
154 # configuration options related to the Perl module output
155 #---------------------------------------------------------------------------
156 GENERATE_PERLMOD       = NO
157 PERLMOD_LATEX          = NO
158 PERLMOD_PRETTY         = YES
159 PERLMOD_MAKEVAR_PREFIX = 
160 #---------------------------------------------------------------------------
161 # Configuration options related to the preprocessor   
162 #---------------------------------------------------------------------------
163 ENABLE_PREPROCESSING   = YES
164 MACRO_EXPANSION        = YES
165 EXPAND_ONLY_PREDEF     = NO
166 SEARCH_INCLUDES        = YES
167 INCLUDE_PATH           = 
168 INCLUDE_FILE_PATTERNS  = 
169 PREDEFINED             = 
170 EXPAND_AS_DEFINED      = 
171 SKIP_FUNCTION_MACROS   = NO
172 #---------------------------------------------------------------------------
173 # Configuration::addtions related to external references   
174 #---------------------------------------------------------------------------
175 TAGFILES               = 
176 GENERATE_TAGFILE       = 
177 ALLEXTERNALS           = NO
178 EXTERNAL_GROUPS        = YES
179 PERL_PATH              = /usr/bin/perl
180 #---------------------------------------------------------------------------
181 # Configuration options related to the dot tool   
182 #---------------------------------------------------------------------------
183 CLASS_DIAGRAMS         = YES
184 HIDE_UNDOC_RELATIONS   = NO
185 HAVE_DOT               = YES
186 CLASS_GRAPH            = YES
187 COLLABORATION_GRAPH    = NO
188 TEMPLATE_RELATIONS     = YES
189 INCLUDE_GRAPH          = YES
190 INCLUDED_BY_GRAPH      = NO
191 GRAPHICAL_HIERARCHY    = YES
192 DOT_IMAGE_FORMAT       = jpg
193 DOT_PATH               = 
194 DOTFILE_DIRS           = 
195 MAX_DOT_GRAPH_WIDTH    = 1024
196 MAX_DOT_GRAPH_HEIGHT   = 1200
197 GENERATE_LEGEND        = NO
198 DOT_CLEANUP            = YES
199 #---------------------------------------------------------------------------
200 # Configuration::addtions related to the search engine   
201 #---------------------------------------------------------------------------
202 SEARCHENGINE           = NO
203 CGI_NAME               = search.cgi
204 CGI_URL                = 
205 DOC_URL                = 
206 DOC_ABSPATH            = 
207 BIN_ABSPATH            = /usr/local/bin/
208 EXT_DOC_PATHS          =