doc/salome/tui/SMESH/doxyfile

   1 # Doxyfile 1.3-rc1
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "SALOME - SMESH - v.3.2.0a2"
   7 PROJECT_NUMBER         = id#1.1
   8 OUTPUT_DIRECTORY       = ../
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = YES
  11 EXTRACT_PRIVATE        = YES
  12 EXTRACT_STATIC         = YES
  13 EXTRACT_LOCAL_CLASSES  = YES
  14 HIDE_UNDOC_MEMBERS     = NO
  15 HIDE_UNDOC_CLASSES     = NO
  16 HIDE_FRIEND_COMPOUNDS  = NO
  17 HIDE_IN_BODY_DOCS      = NO
  18 BRIEF_MEMBER_DESC      = YES
  19 REPEAT_BRIEF           = NO
  20 ALWAYS_DETAILED_SEC    = YES
  21 INLINE_INHERITED_MEMB  = YES
  22 FULL_PATH_NAMES        = NO
  23 STRIP_FROM_PATH        =
  24 INTERNAL_DOCS          = YES
  25 CASE_SENSE_NAMES       = YES
  26 SHORT_NAMES            = NO
  27 HIDE_SCOPE_NAMES       = NO
  28 VERBATIM_HEADERS       = YES
  29 SHOW_INCLUDE_FILES     = YES
  30 JAVADOC_AUTOBRIEF      = YES
  31 MULTILINE_CPP_IS_BRIEF = NO
  32 DETAILS_AT_TOP         = NO
  33 INHERIT_DOCS           = YES
  34 INLINE_INFO            = YES
  35 SORT_MEMBER_DOCS       = NO
  36 DISTRIBUTE_GROUP_DOC   = NO
  37 TAB_SIZE               = 5
  38 GENERATE_TODOLIST      = YES
  39 GENERATE_TESTLIST      = YES
  40 GENERATE_BUGLIST       = YES
  41 GENERATE_DEPRECATEDLIST= YES
  42 ALIASES                =
  43 ENABLED_SECTIONS       =
  44 MAX_INITIALIZER_LINES  = 25
  45 OPTIMIZE_OUTPUT_FOR_C  = YES
  46 OPTIMIZE_OUTPUT_JAVA   = YES
  47 SHOW_USED_FILES        = NO
  48 #---------------------------------------------------------------------------
  49 # configuration options related to warning and progress messages
  50 #---------------------------------------------------------------------------
  51 QUIET                  = NO
  52 WARNINGS               = YES
  53 WARN_IF_UNDOCUMENTED   = YES
  54 WARN_FORMAT            = "$file:$line: $text"
  55 WARN_LOGFILE           = log.txt
  56 #---------------------------------------------------------------------------
  57 # configuration options related to the input files
  58 #---------------------------------------------------------------------------
  59 INPUT                  = ../../../share/salome/idl/SMESH_Gen.idl \
  60                          ../../../share/salome/idl/SMESH_Mesh.idl \
  61                          ../../../share/salome/idl/SMESH_BasicHypothesis.idl \
  62                          ../../../share/salome/idl/SMESH_Hypothesis.idl \
  63                          ../../../build/salome/bin
  64 FILE_PATTERNS          = *.idl python_extension_must_be_here
  65 RECURSIVE              = YES
  66 EXCLUDE                =
  67 EXCLUDE_SYMLINKS       = NO
  68 EXCLUDE_PATTERNS       =
  69 EXAMPLE_PATH           =
  70 EXAMPLE_PATTERNS       =
  71 EXAMPLE_RECURSIVE      = NO
  72 IMAGE_PATH             = sources/
  73 INPUT_FILTER           =
  74 FILTER_SOURCE_FILES    = YES
  75 #---------------------------------------------------------------------------
  76 # configuration options related to source browsing
  77 #---------------------------------------------------------------------------
  78 SOURCE_BROWSER         = NO
  79 INLINE_SOURCES         = NO
  80 STRIP_CODE_COMMENTS    = YES
  81 REFERENCED_BY_RELATION = NO
  82 REFERENCES_RELATION    = YES
  83 #---------------------------------------------------------------------------
  84 # configuration options related to the alphabetical class index
  85 #---------------------------------------------------------------------------
  86 ALPHABETICAL_INDEX     = NO
  87 COLS_IN_ALPHA_INDEX    = 5
  88 IGNORE_PREFIX          =
  89 #---------------------------------------------------------------------------
  90 # configuration options related to the HTML output
  91 #---------------------------------------------------------------------------
  92 GENERATE_HTML          = YES
  93 HTML_OUTPUT            = SMESH
  94 HTML_FILE_EXTENSION    = .html
  95 HTML_HEADER            = sources/myheader.html
  96 HTML_FOOTER            =
  97 HTML_STYLESHEET        =
  98 HTML_ALIGN_MEMBERS     = YES
  99 GENERATE_HTMLHELP      = NO
 100 CHM_FILE               =
 101 HHC_LOCATION           =
 102 GENERATE_CHI           = NO
 103 BINARY_TOC             = YES
 104 TOC_EXPAND             = YES
 105 DISABLE_INDEX          = YES
 106 ENUM_VALUES_PER_LINE   = 4
 107 GENERATE_TREEVIEW      = YES
 108 TREEVIEW_WIDTH         = 250
 109 #---------------------------------------------------------------------------
 110 # configuration options related to the LaTeX output
 111 #---------------------------------------------------------------------------
 112 GENERATE_LATEX         = NO
 113 LATEX_OUTPUT           = latex
 114 LATEX_CMD_NAME         = latex
 115 MAKEINDEX_CMD_NAME     = makeindex
 116 COMPACT_LATEX          = NO
 117 PAPER_TYPE             = a4wide
 118 EXTRA_PACKAGES         =
 119 LATEX_HEADER           =
 120 PDF_HYPERLINKS         = NO
 121 USE_PDFLATEX           = NO
 122 LATEX_BATCHMODE        = NO
 123 #---------------------------------------------------------------------------
 124 # configuration options related to the RTF output
 125 #---------------------------------------------------------------------------
 126 GENERATE_RTF           = NO
 127 RTF_OUTPUT             = rtf
 128 COMPACT_RTF            = NO
 129 RTF_HYPERLINKS         = NO
 130 RTF_STYLESHEET_FILE    =
 131 RTF_EXTENSIONS_FILE    =
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the man page output
 134 #---------------------------------------------------------------------------
 135 GENERATE_MAN           = NO
 136 MAN_OUTPUT             = man
 137 MAN_EXTENSION          = .3
 138 MAN_LINKS              = NO
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the XML output
 141 #---------------------------------------------------------------------------
 142 GENERATE_XML           = NO
 143 XML_SCHEMA             =
 144 XML_DTD                =
 145 #---------------------------------------------------------------------------
 146 # configuration options for the AutoGen Definitions output
 147 #---------------------------------------------------------------------------
 148 GENERATE_AUTOGEN_DEF   = NO
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the Perl module output
 151 #---------------------------------------------------------------------------
 152 GENERATE_PERLMOD       = NO
 153 PERLMOD_LATEX          = NO
 154 PERLMOD_PRETTY         = YES
 155 PERLMOD_MAKEVAR_PREFIX =
 156 #---------------------------------------------------------------------------
 157 # Configuration options related to the preprocessor
 158 #---------------------------------------------------------------------------
 159 ENABLE_PREPROCESSING   = YES
 160 MACRO_EXPANSION        = YES
 161 EXPAND_ONLY_PREDEF     = NO
 162 SEARCH_INCLUDES        = YES
 163 INCLUDE_PATH           =
 164 INCLUDE_FILE_PATTERNS  =
 165 PREDEFINED             =
 166 EXPAND_AS_DEFINED      =
 167 SKIP_FUNCTION_MACROS   = NO
 168 #---------------------------------------------------------------------------
 169 # Configuration::addtions related to external references
 170 #---------------------------------------------------------------------------
 171 TAGFILES               =
 172 GENERATE_TAGFILE       =
 173 ALLEXTERNALS           = NO
 174 EXTERNAL_GROUPS        = YES
 175 PERL_PATH              = /usr/bin/perl
 176 #---------------------------------------------------------------------------
 177 # Configuration options related to the dot tool
 178 #---------------------------------------------------------------------------
 179 CLASS_DIAGRAMS         = YES
 180 HIDE_UNDOC_RELATIONS   = NO
 181 HAVE_DOT               = YES
 182 CLASS_GRAPH            = YES
 183 COLLABORATION_GRAPH    = NO
 184 TEMPLATE_RELATIONS     = YES
 185 INCLUDE_GRAPH          = YES
 186 INCLUDED_BY_GRAPH      = NO
 187 GRAPHICAL_HIERARCHY    = YES
 188 DOT_IMAGE_FORMAT       = jpg
 189 DOT_PATH               =
 190 DOTFILE_DIRS           =
 191 MAX_DOT_GRAPH_WIDTH    = 1024
 192 MAX_DOT_GRAPH_HEIGHT   = 1200
 193 GENERATE_LEGEND        = NO
 194 DOT_CLEANUP            = YES
 195 #---------------------------------------------------------------------------
 196 # Configuration::addtions related to the search engine
 197 #---------------------------------------------------------------------------
 198 SEARCHENGINE           = NO
 199 CGI_NAME               = search.cgi
 200 CGI_URL                =
 201 DOC_URL                =
 202 DOC_ABSPATH            =
 203 BIN_ABSPATH            = /usr/local/bin/
 204 EXT_DOC_PATHS          =