doc/salome/tui/KERNEL/doxyuser.in

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