doc/salome/tui/SUIT/doxyfile

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