]> SALOME platform Git repositories - samples/pycalculator.git/blob - doc/salome/tui/doxyfile.in
Salome HOME
Copyright update 2021
[samples/pycalculator.git] / doc / salome / tui / doxyfile.in
1 #---------------------------------------------------------------------------
2 # Project related configuration options
3 #---------------------------------------------------------------------------
4 PROJECT_NAME           = "PyCalculator Sample Module Programming Guide v.@SALOMEPYCALCULATOR_VERSION@"
5 PROJECT_NUMBER         = id#1.0
6 OUTPUT_DIRECTORY       = PYCALCULATOR
7 CREATE_SUBDIRS         = NO
8 OUTPUT_LANGUAGE        = English
9 USE_WINDOWS_ENCODING   = NO
10 BRIEF_MEMBER_DESC      = YES
11 REPEAT_BRIEF           = NO
12 ABBREVIATE_BRIEF       = 
13 ALWAYS_DETAILED_SEC    = YES
14 INLINE_INHERITED_MEMB  = YES
15 FULL_PATH_NAMES        = YES
16 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
17 STRIP_FROM_INC_PATH    = 
18 SHORT_NAMES            = NO
19 JAVADOC_AUTOBRIEF      = YES
20 MULTILINE_CPP_IS_BRIEF = NO
21 DETAILS_AT_TOP         = NO
22 INHERIT_DOCS           = YES
23 SEPARATE_MEMBER_PAGES  = NO
24 TAB_SIZE               = 5
25 ALIASES                = 
26 OPTIMIZE_OUTPUT_FOR_C  = YES
27 OPTIMIZE_OUTPUT_JAVA   = YES
28 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
29 DISTRIBUTE_GROUP_DOC   = NO
30 SUBGROUPING            = YES
31
32 #---------------------------------------------------------------------------
33 # Build related configuration options
34 #---------------------------------------------------------------------------
35 EXTRACT_ALL            = YES
36 EXTRACT_PRIVATE        = YES
37 EXTRACT_STATIC         = YES
38 EXTRACT_LOCAL_CLASSES  = YES
39 EXTRACT_LOCAL_METHODS  = NO
40 HIDE_UNDOC_MEMBERS     = NO
41 HIDE_UNDOC_CLASSES     = NO
42 HIDE_FRIEND_COMPOUNDS  = NO
43 HIDE_IN_BODY_DOCS      = NO
44 INTERNAL_DOCS          = YES
45 CASE_SENSE_NAMES       = YES
46 HIDE_SCOPE_NAMES       = NO
47 SHOW_INCLUDE_FILES     = YES
48 INLINE_INFO            = YES
49 SORT_MEMBER_DOCS       = NO
50 SORT_BRIEF_DOCS        = NO
51 SORT_BY_SCOPE_NAME     = NO
52 GENERATE_TODOLIST      = YES
53 GENERATE_TESTLIST      = YES
54 GENERATE_BUGLIST       = YES
55 GENERATE_DEPRECATEDLIST= YES
56 ENABLED_SECTIONS       = 
57 MAX_INITIALIZER_LINES  = 25
58 SHOW_USED_FILES        = NO
59 SHOW_DIRECTORIES       = NO
60 FILE_VERSION_FILTER    = 
61
62 #---------------------------------------------------------------------------
63 # configuration options related to warning and progress messages
64 #---------------------------------------------------------------------------
65 QUIET                  = NO
66 WARNINGS               = YES
67 WARN_IF_UNDOCUMENTED   = YES
68 WARN_IF_DOC_ERROR      = YES
69 WARN_NO_PARAMDOC       = NO
70 WARN_FORMAT            = "$file:$line: $text"
71 WARN_LOGFILE           =
72
73 #---------------------------------------------------------------------------
74 # configuration options related to the input files
75 #---------------------------------------------------------------------------
76 INPUT                  = @PROJECT_SOURCE_DIR@/src \
77                          @PROJECT_SOURCE_DIR@/bin \
78                          @PROJECT_SOURCE_DIR@/idl \
79                          @PROJECT_BINARY_DIR@/bin
80 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@
81 RECURSIVE              = YES
82 EXCLUDE                = 
83 EXCLUDE_SYMLINKS       = NO
84 EXCLUDE_PATTERNS       = 
85 EXAMPLE_PATH           = 
86 EXAMPLE_PATTERNS       = 
87 EXAMPLE_RECURSIVE      = NO
88 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
89 INPUT_FILTER           = 
90 FILTER_PATTERNS        = 
91 FILTER_SOURCE_FILES    = YES
92
93 #---------------------------------------------------------------------------
94 # configuration options related to source browsing
95 #---------------------------------------------------------------------------
96 SOURCE_BROWSER         = NO
97 INLINE_SOURCES         = NO
98 STRIP_CODE_COMMENTS    = YES
99 REFERENCED_BY_RELATION = NO
100 REFERENCES_RELATION    = YES
101 USE_HTAGS              = NO
102 VERBATIM_HEADERS       = YES
103
104 #---------------------------------------------------------------------------
105 # configuration options related to the alphabetical class index
106 #---------------------------------------------------------------------------
107 ALPHABETICAL_INDEX     = YES
108 COLS_IN_ALPHA_INDEX    = 3
109 IGNORE_PREFIX          = 
110
111 #---------------------------------------------------------------------------
112 # configuration options related to the HTML output
113 #---------------------------------------------------------------------------
114 GENERATE_HTML          = YES
115 HTML_OUTPUT            = .
116 HTML_FILE_EXTENSION    = .html
117 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
118 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
119 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
120 GENERATE_HTMLHELP      = NO
121 CHM_FILE               = 
122 HHC_LOCATION           = 
123 GENERATE_CHI           = NO
124 BINARY_TOC             = YES
125 TOC_EXPAND             = YES
126 DISABLE_INDEX          = NO
127 ENUM_VALUES_PER_LINE   = 4
128 GENERATE_TREEVIEW      = YES
129 TREEVIEW_WIDTH         = 250
130
131 #---------------------------------------------------------------------------
132 # configuration options related to the LaTeX output
133 #---------------------------------------------------------------------------
134 GENERATE_LATEX         = NO
135 LATEX_OUTPUT           = latex
136 LATEX_CMD_NAME         = latex
137 MAKEINDEX_CMD_NAME     = makeindex
138 COMPACT_LATEX          = NO
139 PAPER_TYPE             = a4wide
140 EXTRA_PACKAGES         = 
141 LATEX_HEADER           = 
142 PDF_HYPERLINKS         = NO
143 USE_PDFLATEX           = NO
144 LATEX_BATCHMODE        = NO
145 LATEX_HIDE_INDICES     = NO
146
147 #---------------------------------------------------------------------------
148 # configuration options related to the RTF output
149 #---------------------------------------------------------------------------
150 GENERATE_RTF           = NO
151 RTF_OUTPUT             = rtf
152 COMPACT_RTF            = NO
153 RTF_HYPERLINKS         = NO
154 RTF_STYLESHEET_FILE    = 
155 RTF_EXTENSIONS_FILE    = 
156
157 #---------------------------------------------------------------------------
158 # configuration options related to the man page output
159 #---------------------------------------------------------------------------
160 GENERATE_MAN           = NO
161 MAN_OUTPUT             = man
162 MAN_EXTENSION          = .3
163 MAN_LINKS              = NO
164
165 #---------------------------------------------------------------------------
166 # configuration options related to the XML output
167 #---------------------------------------------------------------------------
168 GENERATE_XML           = NO
169 XML_OUTPUT             = xml
170 XML_SCHEMA             = 
171 XML_DTD                = 
172 XML_PROGRAMLISTING     = YES
173
174 #---------------------------------------------------------------------------
175 # configuration options for the AutoGen Definitions output
176 #---------------------------------------------------------------------------
177 GENERATE_AUTOGEN_DEF   = NO
178
179 #---------------------------------------------------------------------------
180 # configuration options related to the Perl module output
181 #---------------------------------------------------------------------------
182 GENERATE_PERLMOD       = NO
183 PERLMOD_LATEX          = NO
184 PERLMOD_PRETTY         = YES
185 PERLMOD_MAKEVAR_PREFIX = 
186
187 #---------------------------------------------------------------------------
188 # Configuration options related to the preprocessor   
189 #---------------------------------------------------------------------------
190 ENABLE_PREPROCESSING   = YES
191 MACRO_EXPANSION        = NO
192 EXPAND_ONLY_PREDEF     = NO
193 SEARCH_INCLUDES        = YES
194 INCLUDE_PATH           = 
195 INCLUDE_FILE_PATTERNS  = 
196 PREDEFINED             = 
197 EXPAND_AS_DEFINED      = 
198 SKIP_FUNCTION_MACROS   = NO
199
200 #---------------------------------------------------------------------------
201 # Configuration::additions related to external references   
202 #---------------------------------------------------------------------------
203 TAGFILES               = 
204 GENERATE_TAGFILE       = 
205 ALLEXTERNALS           = NO
206 EXTERNAL_GROUPS        = YES
207 PERL_PATH              = /usr/bin/perl
208
209 #---------------------------------------------------------------------------
210 # Configuration options related to the dot tool   
211 #---------------------------------------------------------------------------
212 CLASS_DIAGRAMS         = YES
213 HIDE_UNDOC_RELATIONS   = NO
214 HAVE_DOT               = YES
215 CLASS_GRAPH            = YES
216 COLLABORATION_GRAPH    = NO
217 GROUP_GRAPHS           = NO
218 UML_LOOK               = NO
219 TEMPLATE_RELATIONS     = YES
220 INCLUDE_GRAPH          = YES
221 INCLUDED_BY_GRAPH      = NO
222 CALL_GRAPH             = NO
223 GRAPHICAL_HIERARCHY    = YES
224 DIRECTORY_GRAPH        = YES
225 DOT_IMAGE_FORMAT       = jpg
226 DOT_FONTNAME           = Arial
227 DOT_PATH               = 
228 DOTFILE_DIRS           = 
229 MAX_DOT_GRAPH_WIDTH    = 1024
230 MAX_DOT_GRAPH_HEIGHT   = 1200
231 MAX_DOT_GRAPH_DEPTH    = 0
232 DOT_TRANSPARENT        = NO
233 DOT_MULTI_TARGETS      = NO
234 GENERATE_LEGEND        = NO
235 DOT_CLEANUP            = YES
236
237 #---------------------------------------------------------------------------
238 # Configuration::additions related to the search engine   
239 #---------------------------------------------------------------------------
240 SEARCHENGINE           = NO