doc/salome/tui/doxyfile.in

   1 # Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 #
   6 # This library is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU Lesser General Public
   8 # License as published by the Free Software Foundation; either
   9 # version 2.1 of the License, or (at your option) any later version.
  10 #
  11 # This library is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # Lesser General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU Lesser General Public
  17 # License along with this library; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 #
  22
  23 #---------------------------------------------------------------------------
  24 # Project related configuration options
  25 #---------------------------------------------------------------------------
  26 PROJECT_NAME           = "SALOME Mesh Module Developer"
  27 PROJECT_NUMBER         =
  28 OUTPUT_DIRECTORY       = SMESH
  29 CREATE_SUBDIRS         = NO
  30 OUTPUT_LANGUAGE        = English
  31 USE_WINDOWS_ENCODING   = NO
  32 BRIEF_MEMBER_DESC      = YES
  33 REPEAT_BRIEF           = YES
  34 ABBREVIATE_BRIEF       =
  35 ALWAYS_DETAILED_SEC    = YES
  36 INLINE_INHERITED_MEMB  = YES
  37 FULL_PATH_NAMES        = YES
  38 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
  39 STRIP_FROM_INC_PATH    =
  40 SHORT_NAMES            = NO
  41 JAVADOC_AUTOBRIEF      = YES
  42 QT_AUTOBRIEF           = YES
  43 MULTILINE_CPP_IS_BRIEF = NO
  44 DETAILS_AT_TOP         = NO
  45 INHERIT_DOCS           = YES
  46 SEPARATE_MEMBER_PAGES  = NO
  47 TAB_SIZE               = 5
  48 ALIASES                =
  49 OPTIMIZE_OUTPUT_FOR_C  = YES
  50 OPTIMIZE_OUTPUT_JAVA   = YES
  51 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
  52 DISTRIBUTE_GROUP_DOC   = NO
  53 SUBGROUPING            = YES
  54
  55 #---------------------------------------------------------------------------
  56 # Build related configuration options
  57 #---------------------------------------------------------------------------
  58 EXTRACT_ALL            = YES
  59 EXTRACT_PRIVATE        = YES
  60 EXTRACT_STATIC         = YES
  61 EXTRACT_LOCAL_CLASSES  = YES
  62 EXTRACT_LOCAL_METHODS  = YES
  63 HIDE_UNDOC_MEMBERS     = NO
  64 HIDE_UNDOC_CLASSES     = NO
  65 HIDE_FRIEND_COMPOUNDS  = NO
  66 HIDE_IN_BODY_DOCS      = NO
  67 INTERNAL_DOCS          = YES
  68 CASE_SENSE_NAMES       = YES
  69 HIDE_SCOPE_NAMES       = NO
  70 SHOW_INCLUDE_FILES     = YES
  71 INLINE_INFO            = YES
  72 SORT_MEMBER_DOCS       = YES
  73 SORT_BRIEF_DOCS        = NO
  74 SORT_BY_SCOPE_NAME     = NO
  75 GENERATE_TODOLIST      = YES
  76 GENERATE_TESTLIST      = YES
  77 GENERATE_BUGLIST       = YES
  78 GENERATE_DEPRECATEDLIST= YES
  79 ENABLED_SECTIONS       =
  80 MAX_INITIALIZER_LINES  = 25
  81 SHOW_USED_FILES        = NO
  82 SHOW_DIRECTORIES       = NO
  83 FILE_VERSION_FILTER    =
  84
  85 #---------------------------------------------------------------------------
  86 # configuration options related to warning and progress messages
  87 #---------------------------------------------------------------------------
  88 QUIET                  = NO
  89 WARNINGS               = YES
  90 WARN_IF_UNDOCUMENTED   = YES
  91 WARN_IF_DOC_ERROR      = YES
  92 WARN_NO_PARAMDOC       = NO
  93 WARN_FORMAT            = "$file:$line: $text"
  94 WARN_LOGFILE           = log.txt
  95
  96 #---------------------------------------------------------------------------
  97 # configuration options related to the input files
  98 #---------------------------------------------------------------------------
  99 INPUT                  = @PROJECT_SOURCE_DIR@/src \
 100                          @PROJECT_SOURCE_DIR@/bin \
 101                          @PROJECT_SOURCE_DIR@/idl \
 102                          @PROJECT_SOURCE_DIR@/bin \
 103                          @CMAKE_CURRENT_SOURCE_DIR@/input
 104 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
 105 RECURSIVE              = YES
 106 EXCLUDE                =
 107 EXCLUDE_SYMLINKS       = NO
 108 EXCLUDE_PATTERNS       =
 109 EXAMPLE_PATH           =
 110 EXAMPLE_PATTERNS       =
 111 EXAMPLE_RECURSIVE      = NO
 112 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
 113 INPUT_FILTER           =
 114 FILTER_PATTERNS        =
 115 FILTER_SOURCE_FILES    = YES
 116
 117 #---------------------------------------------------------------------------
 118 # configuration options related to source browsing
 119 #---------------------------------------------------------------------------
 120 SOURCE_BROWSER         = NO
 121 INLINE_SOURCES         = NO
 122 STRIP_CODE_COMMENTS    = YES
 123 REFERENCED_BY_RELATION = YES
 124 REFERENCES_RELATION    = YES
 125 #USE_HTAGS              = NO
 126 VERBATIM_HEADERS       = YES
 127
 128 #---------------------------------------------------------------------------
 129 # configuration options related to the alphabetical class index
 130 #---------------------------------------------------------------------------
 131 ALPHABETICAL_INDEX     = YES
 132 COLS_IN_ALPHA_INDEX    = 2
 133 IGNORE_PREFIX          =
 134
 135 #---------------------------------------------------------------------------
 136 # configuration options related to the HTML output
 137 #---------------------------------------------------------------------------
 138 GENERATE_HTML          = YES
 139 HTML_OUTPUT            = .
 140 HTML_FILE_EXTENSION    = .html
 141 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 142 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 143 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 144 HTML_ALIGN_MEMBERS     = YES
 145 GENERATE_HTMLHELP      = NO
 146 CHM_FILE               =
 147 HHC_LOCATION           =
 148 GENERATE_CHI           = NO
 149 BINARY_TOC             = NO
 150 TOC_EXPAND             = NO
 151 DISABLE_INDEX          = NO
 152 ENUM_VALUES_PER_LINE   = 4
 153 GENERATE_TREEVIEW      = YES
 154 TREEVIEW_WIDTH         = 250
 155
 156 #---------------------------------------------------------------------------
 157 # configuration options related to the LaTeX output
 158 #---------------------------------------------------------------------------
 159 GENERATE_LATEX         = NO
 160 LATEX_OUTPUT           = latex
 161 LATEX_CMD_NAME         = latex
 162 MAKEINDEX_CMD_NAME     = makeindex
 163 COMPACT_LATEX          = NO
 164 PAPER_TYPE             = a4wide
 165 EXTRA_PACKAGES         =
 166 LATEX_HEADER           =
 167 PDF_HYPERLINKS         = NO
 168 USE_PDFLATEX           = NO
 169 LATEX_BATCHMODE        = NO
 170 LATEX_HIDE_INDICES     = NO
 171
 172 #---------------------------------------------------------------------------
 173 # configuration options related to the RTF output
 174 #---------------------------------------------------------------------------
 175 GENERATE_RTF           = NO
 176 RTF_OUTPUT             = rtf
 177 COMPACT_RTF            = NO
 178 RTF_HYPERLINKS         = NO
 179 RTF_STYLESHEET_FILE    =
 180 RTF_EXTENSIONS_FILE    =
 181
 182 #---------------------------------------------------------------------------
 183 # configuration options related to the man page output
 184 #---------------------------------------------------------------------------
 185 GENERATE_MAN           = NO
 186 MAN_OUTPUT             = man
 187 MAN_EXTENSION          = .3
 188 MAN_LINKS              = NO
 189
 190 #---------------------------------------------------------------------------
 191 # configuration options related to the XML output
 192 #---------------------------------------------------------------------------
 193 GENERATE_XML           = NO
 194 XML_OUTPUT             = xml
 195 XML_SCHEMA             =
 196 XML_DTD                =
 197 XML_PROGRAMLISTING     = YES
 198
 199 #---------------------------------------------------------------------------
 200 # configuration options for the AutoGen Definitions output
 201 #---------------------------------------------------------------------------
 202 GENERATE_AUTOGEN_DEF   = NO
 203
 204 #---------------------------------------------------------------------------
 205 # configuration options related to the Perl module output
 206 #---------------------------------------------------------------------------
 207 GENERATE_PERLMOD       = NO
 208 PERLMOD_LATEX          = NO
 209 PERLMOD_PRETTY         = YES
 210 PERLMOD_MAKEVAR_PREFIX =
 211
 212 #---------------------------------------------------------------------------
 213 # Configuration options related to the preprocessor
 214 #---------------------------------------------------------------------------
 215 ENABLE_PREPROCESSING   = YES
 216 MACRO_EXPANSION        = YES
 217 EXPAND_ONLY_PREDEF     = NO
 218 SEARCH_INCLUDES        = YES
 219 INCLUDE_PATH           =
 220 INCLUDE_FILE_PATTERNS  =
 221 PREDEFINED             =
 222 EXPAND_AS_DEFINED      =
 223 SKIP_FUNCTION_MACROS   = YES
 224
 225 #---------------------------------------------------------------------------
 226 # Configuration::additions related to external references
 227 #---------------------------------------------------------------------------
 228 TAGFILES               =
 229 GENERATE_TAGFILE       =
 230 ALLEXTERNALS           = NO
 231 EXTERNAL_GROUPS        = YES
 232 PERL_PATH              = /usr/bin/perl
 233
 234 #---------------------------------------------------------------------------
 235 # Configuration options related to the dot tool
 236 #---------------------------------------------------------------------------
 237 CLASS_DIAGRAMS         = YES
 238 HIDE_UNDOC_RELATIONS   = NO
 239 HAVE_DOT               = YES
 240 CLASS_GRAPH            = YES
 241 COLLABORATION_GRAPH    = NO
 242 GROUP_GRAPHS           = YES
 243 UML_LOOK               = NO
 244 TEMPLATE_RELATIONS     = YES
 245 INCLUDE_GRAPH          = YES
 246 INCLUDED_BY_GRAPH      = YES
 247 CALL_GRAPH             = NO
 248 GRAPHICAL_HIERARCHY    = YES
 249 DIRECTORY_GRAPH        = YES
 250 DOT_IMAGE_FORMAT       = png
 251 DOT_FONTNAME           = Arial
 252 DOT_PATH               =
 253 DOTFILE_DIRS           =
 254 MAX_DOT_GRAPH_WIDTH    = 1024
 255 MAX_DOT_GRAPH_HEIGHT   = 1024
 256 MAX_DOT_GRAPH_DEPTH    = 1000
 257 DOT_TRANSPARENT        = NO
 258 DOT_MULTI_TARGETS      = NO
 259 GENERATE_LEGEND        = YES
 260 DOT_CLEANUP            = YES
 261
 262 #---------------------------------------------------------------------------
 263 # Configuration::additions related to the search engine
 264 #---------------------------------------------------------------------------
 265 SEARCHENGINE           = NO
 266
 267