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        = NO
  62 SHOW_DIRECTORIES       = NO
  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@/bin \
  81                        @top_srcdir@/idl \
  82                        @top_srcdir@/src/Container \
  83                        @top_srcdir@/src/LifeCycleCORBA \
  84                        @top_srcdir@/src/NamingService \
  85                        @top_srcdir@/src/Notification \
  86                        @top_srcdir@/src/Utils \
  87                        @top_srcdir@/src/DSC
  88 FILE_PATTERNS          = *.idl *.hxx *.cxx python_extension_must_be_here
  89 RECURSIVE              = YES
  90 EXCLUDE                =
  91 EXCLUDE_SYMLINKS       = NO
  92 EXCLUDE_PATTERNS       =
  93 EXAMPLE_PATH           =
  94 EXAMPLE_PATTERNS       =
  95 EXAMPLE_RECURSIVE      = NO
  96 IMAGE_PATH             = sources/
  97 INPUT_FILTER           =
  98 FILTER_PATTERNS        =
  99 FILTER_SOURCE_FILES    = YES
 100
 101 #---------------------------------------------------------------------------
 102 # configuration options related to source browsing
 103 #---------------------------------------------------------------------------
 104 SOURCE_BROWSER         = NO
 105 INLINE_SOURCES         = NO
 106 STRIP_CODE_COMMENTS    = YES
 107 REFERENCED_BY_RELATION = NO
 108 REFERENCES_RELATION    = YES
 109 USE_HTAGS              = NO
 110 VERBATIM_HEADERS       = YES
 111
 112 #---------------------------------------------------------------------------
 113 # configuration options related to the alphabetical class index
 114 #---------------------------------------------------------------------------
 115 ALPHABETICAL_INDEX     = NO
 116 COLS_IN_ALPHA_INDEX    = 3
 117 IGNORE_PREFIX          =
 118
 119 #---------------------------------------------------------------------------
 120 # configuration options related to the HTML output
 121 #---------------------------------------------------------------------------
 122 GENERATE_HTML          = YES
 123 HTML_OUTPUT            = KERNEL
 124 HTML_FILE_EXTENSION    = .html
 125 HTML_HEADER            = sources/myheader.html
 126 HTML_FOOTER            = sources/footer.html
 127 HTML_STYLESHEET        = sources/doxygen.css
 128 HTML_ALIGN_MEMBERS     = YES
 129 GENERATE_HTMLHELP      = NO
 130 CHM_FILE               =
 131 HHC_LOCATION           =
 132 GENERATE_CHI           = NO
 133 BINARY_TOC             = YES
 134 TOC_EXPAND             = YES
 135 DISABLE_INDEX          = NO
 136 ENUM_VALUES_PER_LINE   = 4
 137 GENERATE_TREEVIEW      = NO
 138 TREEVIEW_WIDTH         = 250
 139
 140 #---------------------------------------------------------------------------
 141 # configuration options related to the LaTeX output
 142 #---------------------------------------------------------------------------
 143 GENERATE_LATEX         = NO
 144 LATEX_OUTPUT           = latex
 145 LATEX_CMD_NAME         = latex
 146 MAKEINDEX_CMD_NAME     = makeindex
 147 COMPACT_LATEX          = NO
 148 PAPER_TYPE             = a4wide
 149 EXTRA_PACKAGES         =
 150 LATEX_HEADER           =
 151 PDF_HYPERLINKS         = NO
 152 USE_PDFLATEX           = NO
 153 LATEX_BATCHMODE        = NO
 154 LATEX_HIDE_INDICES     = NO
 155
 156 #---------------------------------------------------------------------------
 157 # configuration options related to the RTF output
 158 #---------------------------------------------------------------------------
 159 GENERATE_RTF           = NO
 160 RTF_OUTPUT             = rtf
 161 COMPACT_RTF            = NO
 162 RTF_HYPERLINKS         = NO
 163 RTF_STYLESHEET_FILE    =
 164 RTF_EXTENSIONS_FILE    =
 165
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the man page output
 168 #---------------------------------------------------------------------------
 169 GENERATE_MAN           = NO
 170 MAN_OUTPUT             = man
 171 MAN_EXTENSION          = .3
 172 MAN_LINKS              = NO
 173
 174 #---------------------------------------------------------------------------
 175 # configuration options related to the XML output
 176 #---------------------------------------------------------------------------
 177 GENERATE_XML           = NO
 178 XML_OUTPUT             = xml
 179 XML_SCHEMA             =
 180 XML_DTD                =
 181 XML_PROGRAMLISTING     = YES
 182
 183 #---------------------------------------------------------------------------
 184 # configuration options for the AutoGen Definitions output
 185 #---------------------------------------------------------------------------
 186 GENERATE_AUTOGEN_DEF   = NO
 187
 188 #---------------------------------------------------------------------------
 189 # configuration options related to the Perl module output
 190 #---------------------------------------------------------------------------
 191 GENERATE_PERLMOD       = NO
 192 PERLMOD_LATEX          = NO
 193 PERLMOD_PRETTY         = YES
 194 PERLMOD_MAKEVAR_PREFIX =
 195
 196 #---------------------------------------------------------------------------
 197 # Configuration options related to the preprocessor
 198 #---------------------------------------------------------------------------
 199 ENABLE_PREPROCESSING   = YES
 200 MACRO_EXPANSION        = YES
 201 EXPAND_ONLY_PREDEF     = NO
 202 SEARCH_INCLUDES        = YES
 203 INCLUDE_PATH           =
 204 INCLUDE_FILE_PATTERNS  =
 205 PREDEFINED             =
 206 EXPAND_AS_DEFINED      =
 207 SKIP_FUNCTION_MACROS   = NO
 208
 209 #---------------------------------------------------------------------------
 210 # Configuration::additions related to external references
 211 #---------------------------------------------------------------------------
 212 TAGFILES               =
 213 GENERATE_TAGFILE       =
 214 ALLEXTERNALS           = NO
 215 EXTERNAL_GROUPS        = YES
 216 PERL_PATH              = /usr/bin/perl
 217
 218 #---------------------------------------------------------------------------
 219 # Configuration options related to the dot tool
 220 #---------------------------------------------------------------------------
 221 CLASS_DIAGRAMS         = NO
 222 HIDE_UNDOC_RELATIONS   = NO
 223 HAVE_DOT               = YES
 224 CLASS_GRAPH            = YES
 225 COLLABORATION_GRAPH    = NO
 226 GROUP_GRAPHS           = NO
 227 UML_LOOK               = NO
 228 TEMPLATE_RELATIONS     = YES
 229 INCLUDE_GRAPH          = YES
 230 INCLUDED_BY_GRAPH      = NO
 231 CALL_GRAPH             = NO
 232 GRAPHICAL_HIERARCHY    = YES
 233 DIRECTORY_GRAPH        = YES
 234 DOT_IMAGE_FORMAT       = jpg
 235 DOT_PATH               =
 236 DOTFILE_DIRS           =
 237 MAX_DOT_GRAPH_WIDTH    = 1024
 238 MAX_DOT_GRAPH_HEIGHT   = 1200
 239 MAX_DOT_GRAPH_DEPTH    = 0
 240 DOT_TRANSPARENT        = NO
 241 DOT_MULTI_TARGETS      = NO
 242 GENERATE_LEGEND        = NO
 243 DOT_CLEANUP            = YES
 244
 245 #---------------------------------------------------------------------------
 246 # Configuration::additions related to the search engine
 247 #---------------------------------------------------------------------------
 248 SEARCHENGINE           = NO