doc/salome/tui/SUIT/doxyfile

   1 # Doxyfile 1.3.7
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "SALOME v.3.1.0"
   7 PROJECT_NUMBER         = id#1.1
   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        = NO
  18 STRIP_FROM_PATH        =
  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 DISTRIBUTE_GROUP_DOC   = NO
  26 TAB_SIZE               = 5
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = YES
  29 OPTIMIZE_OUTPUT_JAVA   = YES
  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
  60 #---------------------------------------------------------------------------
  61 # configuration options related to warning and progress messages
  62 #---------------------------------------------------------------------------
  63 QUIET                  = NO
  64 WARNINGS               = YES
  65 WARN_IF_UNDOCUMENTED   = YES
  66 WARN_IF_DOC_ERROR      = YES
  67 WARN_FORMAT            = "$file:$line: $text"
  68 WARN_LOGFILE           = log.txt
  69
  70 #---------------------------------------------------------------------------
  71 # configuration options related to the input files
  72 #---------------------------------------------------------------------------
  73 INPUT                  = ../../../share/salome/src \
  74                          ../../../share/salome/idl
  75 FILE_PATTERNS          = *.idl *.h *.hh *.hxx *.c *.cc *.cxx *.ixx *.jxx
  76 RECURSIVE              = YES
  77 EXCLUDE                =
  78 EXCLUDE_SYMLINKS       = NO
  79 EXCLUDE_PATTERNS       =
  80 EXAMPLE_PATH           =
  81 EXAMPLE_PATTERNS       =
  82 EXAMPLE_RECURSIVE      = YES
  83 IMAGE_PATH             = sources/
  84 INPUT_FILTER           =
  85 FILTER_SOURCE_FILES    = YES
  86
  87 #---------------------------------------------------------------------------
  88 # configuration options related to source browsing
  89 #---------------------------------------------------------------------------
  90 SOURCE_BROWSER         = NO
  91 INLINE_SOURCES         = NO
  92 STRIP_CODE_COMMENTS    = YES
  93 REFERENCED_BY_RELATION = NO
  94 REFERENCES_RELATION    = YES
  95 VERBATIM_HEADERS       = YES
  96
  97 #---------------------------------------------------------------------------
  98 # configuration options related to the alphabetical class index
  99 #---------------------------------------------------------------------------
 100 ALPHABETICAL_INDEX     = NO
 101 COLS_IN_ALPHA_INDEX    = 5
 102 IGNORE_PREFIX          =
 103
 104 #---------------------------------------------------------------------------
 105 # configuration options related to the HTML output
 106 #---------------------------------------------------------------------------
 107 GENERATE_HTML          = YES
 108 HTML_OUTPUT            = SUIT
 109 HTML_FILE_EXTENSION    = .html
 110 HTML_HEADER            = sources/myheader.html
 111 HTML_FOOTER            =
 112 HTML_STYLESHEET        =
 113 HTML_ALIGN_MEMBERS     = YES
 114 GENERATE_HTMLHELP      = NO
 115 CHM_FILE               =
 116 HHC_LOCATION           =
 117 GENERATE_CHI           = NO
 118 BINARY_TOC             = YES
 119 TOC_EXPAND             = YES
 120 DISABLE_INDEX          = YES
 121 ENUM_VALUES_PER_LINE   = 4
 122 GENERATE_TREEVIEW      = YES
 123 TREEVIEW_WIDTH         = 250
 124
 125 #---------------------------------------------------------------------------
 126 # configuration options related to the LaTeX output
 127 #---------------------------------------------------------------------------
 128 GENERATE_LATEX         = NO
 129 LATEX_OUTPUT           = latex
 130 LATEX_CMD_NAME         = latex
 131 MAKEINDEX_CMD_NAME     = makeindex
 132 COMPACT_LATEX          = NO
 133 PAPER_TYPE             = a4wide
 134 EXTRA_PACKAGES         =
 135 LATEX_HEADER           =
 136 PDF_HYPERLINKS         = NO
 137 USE_PDFLATEX           = NO
 138 LATEX_BATCHMODE        = NO
 139 LATEX_HIDE_INDICES     = NO
 140
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the RTF output
 143 #---------------------------------------------------------------------------
 144 GENERATE_RTF           = NO
 145 RTF_OUTPUT             = rtf
 146 COMPACT_RTF            = NO
 147 RTF_HYPERLINKS         = NO
 148 RTF_STYLESHEET_FILE    =
 149 RTF_EXTENSIONS_FILE    =
 150
 151 #---------------------------------------------------------------------------
 152 # configuration options related to the man page output
 153 #---------------------------------------------------------------------------
 154 GENERATE_MAN           = NO
 155 MAN_OUTPUT             = man
 156 MAN_EXTENSION          = .3
 157 MAN_LINKS              = NO
 158
 159 #---------------------------------------------------------------------------
 160 # configuration options related to the XML output
 161 #---------------------------------------------------------------------------
 162 GENERATE_XML           = NO
 163 XML_OUTPUT             = xml
 164 XML_SCHEMA             =
 165 XML_DTD                =
 166 XML_PROGRAMLISTING     = YES
 167
 168 #---------------------------------------------------------------------------
 169 # configuration options for the AutoGen Definitions output
 170 #---------------------------------------------------------------------------
 171 GENERATE_AUTOGEN_DEF   = NO
 172
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the Perl module output
 175 #---------------------------------------------------------------------------
 176 GENERATE_PERLMOD       = NO
 177 PERLMOD_LATEX          = NO
 178 PERLMOD_PRETTY         = YES
 179 PERLMOD_MAKEVAR_PREFIX =
 180
 181 #---------------------------------------------------------------------------
 182 # Configuration options related to the preprocessor
 183 #---------------------------------------------------------------------------
 184 ENABLE_PREPROCESSING   = YES
 185 MACRO_EXPANSION        = YES
 186 EXPAND_ONLY_PREDEF     = NO
 187 SEARCH_INCLUDES        = YES
 188 INCLUDE_PATH           =
 189 INCLUDE_FILE_PATTERNS  =
 190 PREDEFINED             =
 191 EXPAND_AS_DEFINED      =
 192 SKIP_FUNCTION_MACROS   = NO
 193
 194 #---------------------------------------------------------------------------
 195 # Configuration::additions related to external references
 196 #---------------------------------------------------------------------------
 197 TAGFILES               =
 198 GENERATE_TAGFILE       =
 199 ALLEXTERNALS           = NO
 200 EXTERNAL_GROUPS        = YES
 201 PERL_PATH              = /usr/bin/perl
 202
 203 #---------------------------------------------------------------------------
 204 # Configuration options related to the dot tool
 205 #---------------------------------------------------------------------------
 206 CLASS_DIAGRAMS         = YES
 207 HIDE_UNDOC_RELATIONS   = NO
 208 HAVE_DOT               = YES
 209 CLASS_GRAPH            = YES
 210 COLLABORATION_GRAPH    = NO
 211 UML_LOOK               = NO
 212 TEMPLATE_RELATIONS     = YES
 213 INCLUDE_GRAPH          = YES
 214 INCLUDED_BY_GRAPH      = NO
 215 CALL_GRAPH             = NO
 216 GRAPHICAL_HIERARCHY    = YES
 217 DOT_IMAGE_FORMAT       = jpg
 218 DOT_PATH               =
 219 DOTFILE_DIRS           =
 220 MAX_DOT_GRAPH_WIDTH    = 1024
 221 MAX_DOT_GRAPH_HEIGHT   = 1200
 222 MAX_DOT_GRAPH_DEPTH    = 0
 223 GENERATE_LEGEND        = NO
 224 DOT_CLEANUP            = YES
 225
 226 #---------------------------------------------------------------------------
 227 # Configuration::additions related to the search engine
 228 #---------------------------------------------------------------------------
 229 SEARCHENGINE           = NO