doc/salome/tui/doxyfile.in

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