doc/salome/tui/doxyfile.in

   1 # Copyright (C) 2007-2014  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 # Doxyfile 1.4.6
  24
  25 #---------------------------------------------------------------------------
  26 # Project related configuration options
  27 #---------------------------------------------------------------------------
  28 PROJECT_NAME           = "SALOME Geometry Developer"
  29 PROJECT_NUMBER         =
  30 OUTPUT_DIRECTORY       = GEOM
  31 CREATE_SUBDIRS         = NO
  32 OUTPUT_LANGUAGE        = English
  33 USE_WINDOWS_ENCODING   = NO
  34 BRIEF_MEMBER_DESC      = YES
  35 REPEAT_BRIEF           = NO
  36 ABBREVIATE_BRIEF       =
  37 ALWAYS_DETAILED_SEC    = YES
  38 INLINE_INHERITED_MEMB  = YES
  39 FULL_PATH_NAMES        = YES
  40 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
  41 STRIP_FROM_INC_PATH    =
  42 SHORT_NAMES            = NO
  43 JAVADOC_AUTOBRIEF      = YES
  44 MULTILINE_CPP_IS_BRIEF = NO
  45 DETAILS_AT_TOP         = NO
  46 INHERIT_DOCS           = YES
  47 SEPARATE_MEMBER_PAGES  = NO
  48 TAB_SIZE               = 5
  49 ALIASES                =
  50 OPTIMIZE_OUTPUT_FOR_C  = YES
  51 OPTIMIZE_OUTPUT_JAVA   = YES
  52 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
  53 DISTRIBUTE_GROUP_DOC   = NO
  54 SUBGROUPING            = YES
  55
  56 #---------------------------------------------------------------------------
  57 # Build related configuration options
  58 #---------------------------------------------------------------------------
  59 EXTRACT_ALL            = YES
  60 EXTRACT_PRIVATE        = YES
  61 EXTRACT_STATIC         = YES
  62 EXTRACT_LOCAL_CLASSES  = YES
  63 EXTRACT_LOCAL_METHODS  = NO
  64 HIDE_UNDOC_MEMBERS     = NO
  65 HIDE_UNDOC_CLASSES     = NO
  66 HIDE_FRIEND_COMPOUNDS  = NO
  67 HIDE_IN_BODY_DOCS      = NO
  68 INTERNAL_DOCS          = YES
  69 CASE_SENSE_NAMES       = YES
  70 HIDE_SCOPE_NAMES       = NO
  71 SHOW_INCLUDE_FILES     = YES
  72 INLINE_INFO            = YES
  73 SORT_MEMBER_DOCS       = NO
  74 SORT_BRIEF_DOCS        = NO
  75 SORT_BY_SCOPE_NAME     = NO
  76 GENERATE_TODOLIST      = YES
  77 GENERATE_TESTLIST      = YES
  78 GENERATE_BUGLIST       = YES
  79 GENERATE_DEPRECATEDLIST= YES
  80 ENABLED_SECTIONS       =
  81 MAX_INITIALIZER_LINES  = 25
  82 SHOW_USED_FILES        = NO
  83 SHOW_DIRECTORIES       = NO
  84 FILE_VERSION_FILTER    =
  85
  86 #---------------------------------------------------------------------------
  87 # configuration options related to warning and progress messages
  88 #---------------------------------------------------------------------------
  89 QUIET                  = NO
  90 WARNINGS               = YES
  91 WARN_IF_UNDOCUMENTED   = YES
  92 WARN_IF_DOC_ERROR      = YES
  93 WARN_NO_PARAMDOC       = NO
  94 WARN_FORMAT            = "$file:$line: $text"
  95 WARN_LOGFILE           =
  96
  97 #---------------------------------------------------------------------------
  98 # configuration options related to the input files
  99 #---------------------------------------------------------------------------
 100 INPUT                  = @PROJECT_SOURCE_DIR@/src \
 101                          ./geomBuilder.py \
 102                          @PROJECT_SOURCE_DIR@/bin \
 103                          @PROJECT_SOURCE_DIR@/idl \
 104                          @PROJECT_SOURCE_DIR@/bin \
 105                          @CMAKE_CURRENT_SOURCE_DIR@/input
 106 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
 107 RECURSIVE              = YES
 108 EXCLUDE_SYMLINKS       = NO
 109 EXCLUDE_PATTERNS       =
 110 EXAMPLE_PATH           =
 111 EXAMPLE_PATTERNS       =
 112 EXAMPLE_RECURSIVE      = NO
 113 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
 114 INPUT_FILTER           =
 115 FILTER_PATTERNS        =
 116 FILTER_SOURCE_FILES    = YES
 117
 118 #---------------------------------------------------------------------------
 119 # configuration options related to source browsing
 120 #---------------------------------------------------------------------------
 121 SOURCE_BROWSER         = NO
 122 INLINE_SOURCES         = NO
 123 STRIP_CODE_COMMENTS    = YES
 124 REFERENCED_BY_RELATION = NO
 125 REFERENCES_RELATION    = YES
 126 USE_HTAGS              = NO
 127 VERBATIM_HEADERS       = YES
 128
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the alphabetical class index
 131 #---------------------------------------------------------------------------
 132 ALPHABETICAL_INDEX     = YES
 133 COLS_IN_ALPHA_INDEX    = 3
 134 IGNORE_PREFIX          =
 135
 136 #---------------------------------------------------------------------------
 137 # configuration options related to the HTML output
 138 #---------------------------------------------------------------------------
 139 GENERATE_HTML          = YES
 140 HTML_OUTPUT            = .
 141 HTML_FILE_EXTENSION    = .html
 142 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 143 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 144 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 145 HTML_ALIGN_MEMBERS     = YES
 146 GENERATE_HTMLHELP      = NO
 147 CHM_FILE               =
 148 HHC_LOCATION           =
 149 GENERATE_CHI           = NO
 150 BINARY_TOC             = YES
 151 TOC_EXPAND             = YES
 152 DISABLE_INDEX          = NO
 153 ENUM_VALUES_PER_LINE   = 4
 154 GENERATE_TREEVIEW      = YES
 155 TREEVIEW_WIDTH         = 250
 156
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the LaTeX output
 159 #---------------------------------------------------------------------------
 160 GENERATE_LATEX         = NO
 161 LATEX_OUTPUT           = latex
 162 LATEX_CMD_NAME         = latex
 163 MAKEINDEX_CMD_NAME     = makeindex
 164 COMPACT_LATEX          = NO
 165 PAPER_TYPE             = a4wide
 166 EXTRA_PACKAGES         =
 167 LATEX_HEADER           =
 168 PDF_HYPERLINKS         = NO
 169 USE_PDFLATEX           = NO
 170 LATEX_BATCHMODE        = NO
 171 LATEX_HIDE_INDICES     = NO
 172
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the RTF output
 175 #---------------------------------------------------------------------------
 176 GENERATE_RTF           = NO
 177 RTF_OUTPUT             = rtf
 178 COMPACT_RTF            = NO
 179 RTF_HYPERLINKS         = NO
 180 RTF_STYLESHEET_FILE    =
 181 RTF_EXTENSIONS_FILE    =
 182
 183 #---------------------------------------------------------------------------
 184 # configuration options related to the man page output
 185 #---------------------------------------------------------------------------
 186 GENERATE_MAN           = NO
 187 MAN_OUTPUT             = man
 188 MAN_EXTENSION          = .3
 189 MAN_LINKS              = NO
 190
 191 #---------------------------------------------------------------------------
 192 # configuration options related to the XML output
 193 #---------------------------------------------------------------------------
 194 GENERATE_XML           = NO
 195 XML_OUTPUT             = xml
 196 XML_SCHEMA             =
 197 XML_DTD                =
 198 XML_PROGRAMLISTING     = YES
 199
 200 #---------------------------------------------------------------------------
 201 # configuration options for the AutoGen Definitions output
 202 #---------------------------------------------------------------------------
 203 GENERATE_AUTOGEN_DEF   = NO
 204
 205 #---------------------------------------------------------------------------
 206 # configuration options related to the Perl module output
 207 #---------------------------------------------------------------------------
 208 GENERATE_PERLMOD       = NO
 209 PERLMOD_LATEX          = NO
 210 PERLMOD_PRETTY         = YES
 211 PERLMOD_MAKEVAR_PREFIX =
 212
 213 #---------------------------------------------------------------------------
 214 # Configuration options related to the preprocessor
 215 #---------------------------------------------------------------------------
 216 ENABLE_PREPROCESSING   = YES
 217 MACRO_EXPANSION        = NO
 218 EXPAND_ONLY_PREDEF     = NO
 219 SEARCH_INCLUDES        = YES
 220 INCLUDE_PATH           =
 221 INCLUDE_FILE_PATTERNS  =
 222 PREDEFINED             =
 223 EXPAND_AS_DEFINED      =
 224 SKIP_FUNCTION_MACROS   = NO
 225
 226 #---------------------------------------------------------------------------
 227 # Configuration::additions related to external references
 228 #---------------------------------------------------------------------------
 229 TAGFILES               =
 230 GENERATE_TAGFILE       =
 231 ALLEXTERNALS           = NO
 232 EXTERNAL_GROUPS        = YES
 233 PERL_PATH              = /usr/bin/perl
 234
 235 #---------------------------------------------------------------------------
 236 # Configuration options related to the dot tool
 237 #---------------------------------------------------------------------------
 238 CLASS_DIAGRAMS         = YES
 239 HIDE_UNDOC_RELATIONS   = NO
 240 HAVE_DOT               = YES
 241 CLASS_GRAPH            = YES
 242 COLLABORATION_GRAPH    = NO
 243 GROUP_GRAPHS           = NO
 244 UML_LOOK               = NO
 245 TEMPLATE_RELATIONS     = YES
 246 INCLUDE_GRAPH          = YES
 247 INCLUDED_BY_GRAPH      = NO
 248 CALL_GRAPH             = NO
 249 GRAPHICAL_HIERARCHY    = YES
 250 DIRECTORY_GRAPH        = YES
 251 DOT_IMAGE_FORMAT       = png
 252 DOT_FONTNAME           = Arial
 253 DOT_PATH               =
 254 DOTFILE_DIRS           =
 255 MAX_DOT_GRAPH_WIDTH    = 1024
 256 MAX_DOT_GRAPH_HEIGHT   = 1200
 257 MAX_DOT_GRAPH_DEPTH    = 0
 258 DOT_TRANSPARENT        = NO
 259 DOT_MULTI_TARGETS      = NO
 260 GENERATE_LEGEND        = NO
 261 DOT_CLEANUP            = YES
 262
 263 #---------------------------------------------------------------------------
 264 # Configuration::additions related to the search engine
 265 #---------------------------------------------------------------------------
 266 SEARCHENGINE           = NO