doc/salome/tui/doxyfile.in

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