doc/salome/gui/doxyfile.in

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