doc/salome/tui/doxyfile.in

   1 #---------------------------------------------------------------------------
   2 # Project related configuration options
   3 #---------------------------------------------------------------------------
   4 PROJECT_NAME           = "SALOME Mesh Module Developer"
   5 PROJECT_NUMBER         =
   6 OUTPUT_DIRECTORY       = SMESH
   7 CREATE_SUBDIRS         = NO
   8 OUTPUT_LANGUAGE        = English
   9 USE_WINDOWS_ENCODING   = NO
  10 BRIEF_MEMBER_DESC      = YES
  11 REPEAT_BRIEF           = YES
  12 ABBREVIATE_BRIEF       =
  13 ALWAYS_DETAILED_SEC    = YES
  14 INLINE_INHERITED_MEMB  = YES
  15 FULL_PATH_NAMES        = YES
  16 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
  17 STRIP_FROM_INC_PATH    =
  18 SHORT_NAMES            = NO
  19 JAVADOC_AUTOBRIEF      = YES
  20 QT_AUTOBRIEF           = YES
  21 MULTILINE_CPP_IS_BRIEF = NO
  22 DETAILS_AT_TOP         = NO
  23 INHERIT_DOCS           = YES
  24 SEPARATE_MEMBER_PAGES  = NO
  25 TAB_SIZE               = 5
  26 ALIASES                =
  27 OPTIMIZE_OUTPUT_FOR_C  = YES
  28 OPTIMIZE_OUTPUT_JAVA   = YES
  29 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
  30 DISTRIBUTE_GROUP_DOC   = NO
  31 SUBGROUPING            = YES
  32
  33 #---------------------------------------------------------------------------
  34 # Build related configuration options
  35 #---------------------------------------------------------------------------
  36 EXTRACT_ALL            = YES
  37 EXTRACT_PRIVATE        = YES
  38 EXTRACT_STATIC         = YES
  39 EXTRACT_LOCAL_CLASSES  = YES
  40 EXTRACT_LOCAL_METHODS  = YES
  41 HIDE_UNDOC_MEMBERS     = NO
  42 HIDE_UNDOC_CLASSES     = NO
  43 HIDE_FRIEND_COMPOUNDS  = NO
  44 HIDE_IN_BODY_DOCS      = NO
  45 INTERNAL_DOCS          = YES
  46 CASE_SENSE_NAMES       = YES
  47 HIDE_SCOPE_NAMES       = NO
  48 SHOW_INCLUDE_FILES     = YES
  49 INLINE_INFO            = YES
  50 SORT_MEMBER_DOCS       = YES
  51 SORT_BRIEF_DOCS        = NO
  52 SORT_BY_SCOPE_NAME     = NO
  53 GENERATE_TODOLIST      = YES
  54 GENERATE_TESTLIST      = YES
  55 GENERATE_BUGLIST       = YES
  56 GENERATE_DEPRECATEDLIST= YES
  57 ENABLED_SECTIONS       =
  58 MAX_INITIALIZER_LINES  = 25
  59 SHOW_USED_FILES        = NO
  60 SHOW_DIRECTORIES       = NO
  61 FILE_VERSION_FILTER    =
  62
  63 #---------------------------------------------------------------------------
  64 # configuration options related to warning and progress messages
  65 #---------------------------------------------------------------------------
  66 QUIET                  = NO
  67 WARNINGS               = YES
  68 WARN_IF_UNDOCUMENTED   = YES
  69 WARN_IF_DOC_ERROR      = YES
  70 WARN_NO_PARAMDOC       = NO
  71 WARN_FORMAT            = "$file:$line: $text"
  72 WARN_LOGFILE           = log.txt
  73
  74 #---------------------------------------------------------------------------
  75 # configuration options related to the input files
  76 #---------------------------------------------------------------------------
  77 INPUT                  = @PROJECT_SOURCE_DIR@/src \
  78                          @PROJECT_SOURCE_DIR@/bin \
  79                          @PROJECT_SOURCE_DIR@/idl \
  80                          @PROJECT_SOURCE_DIR@/bin \
  81                          @CMAKE_CURRENT_SOURCE_DIR@/input
  82 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
  83 RECURSIVE              = YES
  84 EXCLUDE                =
  85 EXCLUDE_SYMLINKS       = NO
  86 EXCLUDE_PATTERNS       =
  87 EXAMPLE_PATH           =
  88 EXAMPLE_PATTERNS       =
  89 EXAMPLE_RECURSIVE      = NO
  90 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
  91 INPUT_FILTER           =
  92 FILTER_PATTERNS        =
  93 FILTER_SOURCE_FILES    = YES
  94
  95 #---------------------------------------------------------------------------
  96 # configuration options related to source browsing
  97 #---------------------------------------------------------------------------
  98 SOURCE_BROWSER         = NO
  99 INLINE_SOURCES         = NO
 100 STRIP_CODE_COMMENTS    = YES
 101 REFERENCED_BY_RELATION = YES
 102 REFERENCES_RELATION    = YES
 103 #USE_HTAGS              = NO
 104 VERBATIM_HEADERS       = YES
 105
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the alphabetical class index
 108 #---------------------------------------------------------------------------
 109 ALPHABETICAL_INDEX     = YES
 110 COLS_IN_ALPHA_INDEX    = 2
 111 IGNORE_PREFIX          =
 112
 113 #---------------------------------------------------------------------------
 114 # configuration options related to the HTML output
 115 #---------------------------------------------------------------------------
 116 GENERATE_HTML          = YES
 117 HTML_OUTPUT            = .
 118 HTML_FILE_EXTENSION    = .html
 119 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 120 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 121 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 122 HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
 123 HTML_ALIGN_MEMBERS     = YES
 124 GENERATE_HTMLHELP      = NO
 125 CHM_FILE               =
 126 HHC_LOCATION           =
 127 GENERATE_CHI           = NO
 128 BINARY_TOC             = NO
 129 TOC_EXPAND             = NO
 130 DISABLE_INDEX          = NO
 131 ENUM_VALUES_PER_LINE   = 4
 132 GENERATE_TREEVIEW      = YES
 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   = YES
 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           = YES
 222 UML_LOOK               = NO
 223 TEMPLATE_RELATIONS     = YES
 224 INCLUDE_GRAPH          = YES
 225 INCLUDED_BY_GRAPH      = YES
 226 CALL_GRAPH             = NO
 227 GRAPHICAL_HIERARCHY    = YES
 228 DIRECTORY_GRAPH        = YES
 229 DOT_IMAGE_FORMAT       = png
 230 DOT_FONTNAME           = Arial
 231 DOT_PATH               =
 232 DOTFILE_DIRS           =
 233 MAX_DOT_GRAPH_WIDTH    = 1024
 234 MAX_DOT_GRAPH_HEIGHT   = 1024
 235 MAX_DOT_GRAPH_DEPTH    = 1000
 236 DOT_TRANSPARENT        = NO
 237 DOT_MULTI_TARGETS      = NO
 238 GENERATE_LEGEND        = YES
 239 DOT_CLEANUP            = YES
 240
 241 #---------------------------------------------------------------------------
 242 # Configuration::additions related to the search engine
 243 #---------------------------------------------------------------------------
 244 SEARCHENGINE           = NO
 245
 246