doc/salome/tui/doxyfile.in

   1 #  Copyright (C) 2007-2008  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.
  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           = "Geometry Module Programming Guide v.@VERSION@"
  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        = @top_srcdir@ @top_builddir@
  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                  = @top_srcdir@/src \
 101                          @top_builddir@/src/GEOM_SWIG/geompy.py \
 102                          @top_srcdir@/bin \
 103                          @top_srcdir@/idl \
 104                          @top_builddir@/bin
 105 FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@
 106 RECURSIVE              = YES
 107 EXCLUDE                = @top_srcdir@/src/GEOM_SWIG/geompy.py \
 108                          @top_srcdir@/src/GEOM_SWIG/geompyDC.py
 109 EXCLUDE_SYMLINKS       = NO
 110 EXCLUDE_PATTERNS       =
 111 EXAMPLE_PATH           =
 112 EXAMPLE_PATTERNS       =
 113 EXAMPLE_RECURSIVE      = NO
 114 IMAGE_PATH             = @srcdir@/images
 115 INPUT_FILTER           =
 116 FILTER_PATTERNS        =
 117 FILTER_SOURCE_FILES    = YES
 118
 119 #---------------------------------------------------------------------------
 120 # configuration options related to source browsing
 121 #---------------------------------------------------------------------------
 122 SOURCE_BROWSER         = NO
 123 INLINE_SOURCES         = NO
 124 STRIP_CODE_COMMENTS    = YES
 125 REFERENCED_BY_RELATION = NO
 126 REFERENCES_RELATION    = YES
 127 USE_HTAGS              = NO
 128 VERBATIM_HEADERS       = YES
 129
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the alphabetical class index
 132 #---------------------------------------------------------------------------
 133 ALPHABETICAL_INDEX     = YES
 134 COLS_IN_ALPHA_INDEX    = 3
 135 IGNORE_PREFIX          =
 136
 137 #---------------------------------------------------------------------------
 138 # configuration options related to the HTML output
 139 #---------------------------------------------------------------------------
 140 GENERATE_HTML          = YES
 141 HTML_OUTPUT            = .
 142 HTML_FILE_EXTENSION    = .html
 143 HTML_HEADER            = @srcdir@/static/myheader.html
 144 HTML_FOOTER            = @srcdir@/static/footer.html
 145 HTML_STYLESHEET        = @srcdir@/static/doxygen.css
 146 HTML_ALIGN_MEMBERS     = YES
 147 GENERATE_HTMLHELP      = NO
 148 CHM_FILE               =
 149 HHC_LOCATION           =
 150 GENERATE_CHI           = NO
 151 BINARY_TOC             = YES
 152 TOC_EXPAND             = YES
 153 DISABLE_INDEX          = NO
 154 ENUM_VALUES_PER_LINE   = 4
 155 GENERATE_TREEVIEW      = NO
 156 TREEVIEW_WIDTH         = 250
 157
 158 #---------------------------------------------------------------------------
 159 # configuration options related to the LaTeX output
 160 #---------------------------------------------------------------------------
 161 GENERATE_LATEX         = NO
 162 LATEX_OUTPUT           = latex
 163 LATEX_CMD_NAME         = latex
 164 MAKEINDEX_CMD_NAME     = makeindex
 165 COMPACT_LATEX          = NO
 166 PAPER_TYPE             = a4wide
 167 EXTRA_PACKAGES         =
 168 LATEX_HEADER           =
 169 PDF_HYPERLINKS         = NO
 170 USE_PDFLATEX           = NO
 171 LATEX_BATCHMODE        = NO
 172 LATEX_HIDE_INDICES     = NO
 173
 174 #---------------------------------------------------------------------------
 175 # configuration options related to the RTF output
 176 #---------------------------------------------------------------------------
 177 GENERATE_RTF           = NO
 178 RTF_OUTPUT             = rtf
 179 COMPACT_RTF            = NO
 180 RTF_HYPERLINKS         = NO
 181 RTF_STYLESHEET_FILE    =
 182 RTF_EXTENSIONS_FILE    =
 183
 184 #---------------------------------------------------------------------------
 185 # configuration options related to the man page output
 186 #---------------------------------------------------------------------------
 187 GENERATE_MAN           = NO
 188 MAN_OUTPUT             = man
 189 MAN_EXTENSION          = .3
 190 MAN_LINKS              = NO
 191
 192 #---------------------------------------------------------------------------
 193 # configuration options related to the XML output
 194 #---------------------------------------------------------------------------
 195 GENERATE_XML           = NO
 196 XML_OUTPUT             = xml
 197 XML_SCHEMA             =
 198 XML_DTD                =
 199 XML_PROGRAMLISTING     = YES
 200
 201 #---------------------------------------------------------------------------
 202 # configuration options for the AutoGen Definitions output
 203 #---------------------------------------------------------------------------
 204 GENERATE_AUTOGEN_DEF   = NO
 205
 206 #---------------------------------------------------------------------------
 207 # configuration options related to the Perl module output
 208 #---------------------------------------------------------------------------
 209 GENERATE_PERLMOD       = NO
 210 PERLMOD_LATEX          = NO
 211 PERLMOD_PRETTY         = YES
 212 PERLMOD_MAKEVAR_PREFIX =
 213
 214 #---------------------------------------------------------------------------
 215 # Configuration options related to the preprocessor
 216 #---------------------------------------------------------------------------
 217 ENABLE_PREPROCESSING   = YES
 218 MACRO_EXPANSION        = NO
 219 EXPAND_ONLY_PREDEF     = NO
 220 SEARCH_INCLUDES        = YES
 221 INCLUDE_PATH           =
 222 INCLUDE_FILE_PATTERNS  =
 223 PREDEFINED             =
 224 EXPAND_AS_DEFINED      =
 225 SKIP_FUNCTION_MACROS   = NO
 226
 227 #---------------------------------------------------------------------------
 228 # Configuration::additions related to external references
 229 #---------------------------------------------------------------------------
 230 TAGFILES               =
 231 GENERATE_TAGFILE       =
 232 ALLEXTERNALS           = NO
 233 EXTERNAL_GROUPS        = YES
 234 PERL_PATH              = /usr/bin/perl
 235
 236 #---------------------------------------------------------------------------
 237 # Configuration options related to the dot tool
 238 #---------------------------------------------------------------------------
 239 CLASS_DIAGRAMS         = YES
 240 HIDE_UNDOC_RELATIONS   = NO
 241 HAVE_DOT               = YES
 242 CLASS_GRAPH            = YES
 243 COLLABORATION_GRAPH    = NO
 244 GROUP_GRAPHS           = NO
 245 UML_LOOK               = NO
 246 TEMPLATE_RELATIONS     = YES
 247 INCLUDE_GRAPH          = YES
 248 INCLUDED_BY_GRAPH      = NO
 249 CALL_GRAPH             = NO
 250 GRAPHICAL_HIERARCHY    = YES
 251 DIRECTORY_GRAPH        = YES
 252 DOT_IMAGE_FORMAT       = jpg
 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