Salome HOME
Change version name to 3.2.0a2
[modules/smesh.git] / doc / salome / tui / SMESH / doxyfile_py
1 # Doxyfile 1.3-rc1
2
3 #---------------------------------------------------------------------------
4 # General configuration options
5 #---------------------------------------------------------------------------
6 PROJECT_NAME           = "SALOME - SMESH - v.3.2.0a2"
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                  = list_py_files_to_process
60 FILE_PATTERNS          = 
61 RECURSIVE              = NO
62 EXCLUDE                = 
63 EXCLUDE_SYMLINKS       = NO
64 EXCLUDE_PATTERNS       = 
65 EXAMPLE_PATH           = 
66 EXAMPLE_PATTERNS       = 
67 EXAMPLE_RECURSIVE      = NO
68 IMAGE_PATH             = ../sources/
69 INPUT_FILTER           = 
70 FILTER_SOURCE_FILES    = YES
71 #---------------------------------------------------------------------------
72 # configuration options related to source browsing
73 #---------------------------------------------------------------------------
74 SOURCE_BROWSER         = NO
75 INLINE_SOURCES         = NO
76 STRIP_CODE_COMMENTS    = YES
77 REFERENCED_BY_RELATION = NO
78 REFERENCES_RELATION    = YES
79 #---------------------------------------------------------------------------
80 # configuration options related to the alphabetical class index
81 #---------------------------------------------------------------------------
82 ALPHABETICAL_INDEX     = NO
83 COLS_IN_ALPHA_INDEX    = 5
84 IGNORE_PREFIX          = 
85 #---------------------------------------------------------------------------
86 # configuration options related to the HTML output
87 #---------------------------------------------------------------------------
88 GENERATE_HTML          = YES
89 HTML_OUTPUT            = ../SMESH/meshpy_doc
90 HTML_FILE_EXTENSION    = .html
91 HTML_HEADER            = ../sources/myheader_py2.html
92 HTML_FOOTER            = 
93 HTML_STYLESHEET        = 
94 HTML_ALIGN_MEMBERS     = YES
95 GENERATE_HTMLHELP      = NO
96 CHM_FILE               = 
97 HHC_LOCATION           = 
98 GENERATE_CHI           = NO
99 BINARY_TOC             = YES
100 TOC_EXPAND             = YES
101 DISABLE_INDEX          = YES
102 ENUM_VALUES_PER_LINE   = 4
103 GENERATE_TREEVIEW      = YES
104 TREEVIEW_WIDTH         = 250
105 #---------------------------------------------------------------------------
106 # configuration options related to the LaTeX output
107 #---------------------------------------------------------------------------
108 GENERATE_LATEX         = NO
109 LATEX_OUTPUT           = latex
110 LATEX_CMD_NAME         = latex
111 MAKEINDEX_CMD_NAME     = makeindex
112 COMPACT_LATEX          = NO
113 PAPER_TYPE             = a4wide
114 EXTRA_PACKAGES         = 
115 LATEX_HEADER           = 
116 PDF_HYPERLINKS         = NO
117 USE_PDFLATEX           = NO
118 LATEX_BATCHMODE        = NO
119 #---------------------------------------------------------------------------
120 # configuration options related to the RTF output
121 #---------------------------------------------------------------------------
122 GENERATE_RTF           = NO
123 RTF_OUTPUT             = rtf
124 COMPACT_RTF            = NO
125 RTF_HYPERLINKS         = NO
126 RTF_STYLESHEET_FILE    = 
127 RTF_EXTENSIONS_FILE    = 
128 #---------------------------------------------------------------------------
129 # configuration options related to the man page output
130 #---------------------------------------------------------------------------
131 GENERATE_MAN           = NO
132 MAN_OUTPUT             = man
133 MAN_EXTENSION          = .3
134 MAN_LINKS              = NO
135 #---------------------------------------------------------------------------
136 # configuration options related to the XML output
137 #---------------------------------------------------------------------------
138 GENERATE_XML           = NO
139 XML_SCHEMA             = 
140 XML_DTD                = 
141 #---------------------------------------------------------------------------
142 # configuration options for the AutoGen Definitions output
143 #---------------------------------------------------------------------------
144 GENERATE_AUTOGEN_DEF   = NO
145 #---------------------------------------------------------------------------
146 # configuration options related to the Perl module output
147 #---------------------------------------------------------------------------
148 GENERATE_PERLMOD       = NO
149 PERLMOD_LATEX          = NO
150 PERLMOD_PRETTY         = YES
151 PERLMOD_MAKEVAR_PREFIX = 
152 #---------------------------------------------------------------------------
153 # Configuration options related to the preprocessor   
154 #---------------------------------------------------------------------------
155 ENABLE_PREPROCESSING   = YES
156 MACRO_EXPANSION        = YES
157 EXPAND_ONLY_PREDEF     = NO
158 SEARCH_INCLUDES        = YES
159 INCLUDE_PATH           = 
160 INCLUDE_FILE_PATTERNS  = 
161 PREDEFINED             = 
162 EXPAND_AS_DEFINED      = 
163 SKIP_FUNCTION_MACROS   = NO
164 #---------------------------------------------------------------------------
165 # Configuration::addtions related to external references   
166 #---------------------------------------------------------------------------
167 TAGFILES               = 
168 GENERATE_TAGFILE       = 
169 ALLEXTERNALS           = NO
170 EXTERNAL_GROUPS        = YES
171 PERL_PATH              = /usr/bin/perl
172 #---------------------------------------------------------------------------
173 # Configuration options related to the dot tool   
174 #---------------------------------------------------------------------------
175 CLASS_DIAGRAMS         = YES
176 HIDE_UNDOC_RELATIONS   = NO
177 HAVE_DOT               = YES
178 CLASS_GRAPH            = YES
179 COLLABORATION_GRAPH    = NO
180 TEMPLATE_RELATIONS     = YES
181 INCLUDE_GRAPH          = YES
182 INCLUDED_BY_GRAPH      = NO
183 GRAPHICAL_HIERARCHY    = YES
184 DOT_IMAGE_FORMAT       = jpg
185 DOT_PATH               = 
186 DOTFILE_DIRS           = 
187 MAX_DOT_GRAPH_WIDTH    = 1024
188 MAX_DOT_GRAPH_HEIGHT   = 1200
189 GENERATE_LEGEND        = NO
190 DOT_CLEANUP            = YES
191 #---------------------------------------------------------------------------
192 # Configuration::addtions related to the search engine   
193 #---------------------------------------------------------------------------
194 SEARCHENGINE           = NO
195 CGI_NAME               = search.cgi
196 CGI_URL                = 
197 DOC_URL                = 
198 DOC_ABSPATH            = 
199 BIN_ABSPATH            = /usr/local/bin/
200 EXT_DOC_PATHS          =