doc/Doxyfile.in

   1 #  Copyright (C) 2006-2008  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.2
  20 #---------------------------------------------------------------------------
  21 # Project related configuration options
  22 #---------------------------------------------------------------------------
  23 #
  24 PROJECT_NAME           = YACS
  25 PROJECT_NUMBER         = 0.1
  26 OUTPUT_DIRECTORY       = .
  27 CREATE_SUBDIRS         = NO
  28 OUTPUT_LANGUAGE        = English
  29 USE_WINDOWS_ENCODING   = NO
  30 BRIEF_MEMBER_DESC      = YES
  31 REPEAT_BRIEF           = YES
  32 ABBREVIATE_BRIEF       = "The $name class" \
  33                          "The $name widget" \
  34                          "The $name file" \
  35                          is \
  36                          provides \
  37                          specifies \
  38                          contains \
  39                          represents \
  40                          a \
  41                          an \
  42                          the
  43 ALWAYS_DETAILED_SEC    = NO
  44 INLINE_INHERITED_MEMB  = NO
  45 FULL_PATH_NAMES        = YES
  46 STRIP_FROM_PATH        =
  47 STRIP_FROM_INC_PATH    =
  48 SHORT_NAMES            = NO
  49 JAVADOC_AUTOBRIEF      = NO
  50 MULTILINE_CPP_IS_BRIEF = NO
  51 DETAILS_AT_TOP         = NO
  52 INHERIT_DOCS           = YES
  53 DISTRIBUTE_GROUP_DOC   = NO
  54 SEPARATE_MEMBER_PAGES  = NO
  55 TAB_SIZE               = 8
  56 ALIASES                =
  57 OPTIMIZE_OUTPUT_FOR_C  = NO
  58 OPTIMIZE_OUTPUT_JAVA   = NO
  59 SUBGROUPING            = YES
  60 #---------------------------------------------------------------------------
  61 # Build related configuration options
  62 #---------------------------------------------------------------------------
  63 EXTRACT_ALL            = YES
  64 EXTRACT_PRIVATE        = YES
  65 EXTRACT_STATIC         = YES
  66 EXTRACT_LOCAL_CLASSES  = YES
  67 EXTRACT_LOCAL_METHODS  = NO
  68 HIDE_UNDOC_MEMBERS     = NO
  69 HIDE_UNDOC_CLASSES     = NO
  70 HIDE_FRIEND_COMPOUNDS  = NO
  71 HIDE_IN_BODY_DOCS      = NO
  72 INTERNAL_DOCS          = NO
  73 CASE_SENSE_NAMES       = YES
  74 HIDE_SCOPE_NAMES       = NO
  75 SHOW_INCLUDE_FILES     = YES
  76 INLINE_INFO            = YES
  77 SORT_MEMBER_DOCS       = YES
  78 SORT_BRIEF_DOCS        = NO
  79 SORT_BY_SCOPE_NAME     = NO
  80 GENERATE_TODOLIST      = YES
  81 GENERATE_TESTLIST      = YES
  82 GENERATE_BUGLIST       = YES
  83 GENERATE_DEPRECATEDLIST= YES
  84 ENABLED_SECTIONS       =
  85 MAX_INITIALIZER_LINES  = 30
  86 SHOW_USED_FILES        = YES
  87 SHOW_DIRECTORIES       = YES
  88 FILE_VERSION_FILTER    =
  89 #---------------------------------------------------------------------------
  90 # configuration options related to warning and progress messages
  91 #---------------------------------------------------------------------------
  92 QUIET                  = NO
  93 WARNINGS               = YES
  94 WARN_IF_UNDOCUMENTED   = YES
  95 WARN_IF_DOC_ERROR      = YES
  96 WARN_NO_PARAMDOC       = NO
  97 WARN_FORMAT            = "$file:$line: $text"
  98 WARN_LOGFILE           =
  99 #---------------------------------------------------------------------------
 100 # configuration options related to the input files
 101 #---------------------------------------------------------------------------
 102 INPUT                  =  \
 103    @top_srcdir@/doc      \
 104    @top_srcdir@/idl \
 105    @top_srcdir@/src/bases \
 106    @top_srcdir@/src/engine \
 107    @top_srcdir@/src/runtime \
 108    @top_srcdir@/src/yacsloader \
 109    @top_srcdir@/src/yacsorb \
 110    @top_srcdir@/src/hmi \
 111    @top_srcdir@/src/salomewrap \
 112    @top_srcdir@/src/genericgui \
 113    @top_srcdir@/src/salomegui \
 114    @top_srcdir@/src/salomewrap \
 115    @top_srcdir@/src/pyqt
 116
 117 FILE_PATTERNS          = *.c \
 118                          *.cc \
 119                          *.cxx \
 120                          *.cpp \
 121                          *.c++ \
 122                          *.py \
 123                          *.d \
 124                          *.java \
 125                          *.ii \
 126                          *.ixx \
 127                          *.ipp \
 128                          *.i++ \
 129                          *.inl \
 130                          *.h \
 131                          *.hh \
 132                          *.hxx \
 133                          *.hpp \
 134                          *.h++ \
 135                          *.idl \
 136                          *.odl \
 137                          *.cs \
 138                          *.php \
 139                          *.php3 \
 140                          *.inc \
 141                          *.m \
 142                          *.mm \
 143                          *.dox \
 144                          *.C \
 145                          *.CC \
 146                          *.C++ \
 147                          *.II \
 148                          *.I++ \
 149                          *.H \
 150                          *.HH \
 151                          *.H++ \
 152                          *.CS \
 153                          *.PHP \
 154                          *.PHP3 \
 155                          *.M \
 156                          *.MM
 157 RECURSIVE              = YES
 158 EXCLUDE                = @top_srcdir@/src/yacsloader/tools
 159 EXCLUDE_SYMLINKS       = NO
 160 EXCLUDE_PATTERNS       = */Test/*
 161 EXAMPLE_PATH           =
 162 EXAMPLE_PATTERNS       = *
 163 EXAMPLE_RECURSIVE      = NO
 164 IMAGE_PATH             = @top_srcdir@/doc
 165 INPUT_FILTER           =
 166 FILTER_PATTERNS        =
 167 FILTER_SOURCE_FILES    = NO
 168 #---------------------------------------------------------------------------
 169 # configuration options related to source browsing
 170 #---------------------------------------------------------------------------
 171 SOURCE_BROWSER         = YES
 172 INLINE_SOURCES         = YES
 173 STRIP_CODE_COMMENTS    = YES
 174 REFERENCED_BY_RELATION = YES
 175 REFERENCES_RELATION    = YES
 176 VERBATIM_HEADERS       = YES
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the alphabetical class index
 179 #---------------------------------------------------------------------------
 180 ALPHABETICAL_INDEX     = YES
 181 COLS_IN_ALPHA_INDEX    = 2
 182 IGNORE_PREFIX          =
 183 #---------------------------------------------------------------------------
 184 # configuration options related to the HTML output
 185 #---------------------------------------------------------------------------
 186 GENERATE_HTML          = YES
 187 HTML_OUTPUT            = htmldev
 188 HTML_FILE_EXTENSION    = .html
 189 HTML_HEADER            = @top_srcdir@/doc/sources/header.html
 190 HTML_FOOTER            = @top_srcdir@/doc/sources/footer.html
 191 HTML_STYLESHEET        =
 192 HTML_ALIGN_MEMBERS     = YES
 193 GENERATE_HTMLHELP      = NO
 194 CHM_FILE               =
 195 HHC_LOCATION           =
 196 GENERATE_CHI           = NO
 197 BINARY_TOC             = NO
 198 TOC_EXPAND             = NO
 199 DISABLE_INDEX          = NO
 200 ENUM_VALUES_PER_LINE   = 4
 201 GENERATE_TREEVIEW      = YES
 202 TREEVIEW_WIDTH         = 250
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the LaTeX output
 205 #---------------------------------------------------------------------------
 206 GENERATE_LATEX         = NO
 207 LATEX_OUTPUT           = latex
 208 LATEX_CMD_NAME         = latex
 209 MAKEINDEX_CMD_NAME     = makeindex
 210 COMPACT_LATEX          = NO
 211 PAPER_TYPE             = a4wide
 212 EXTRA_PACKAGES         =
 213 LATEX_HEADER           =
 214 PDF_HYPERLINKS         = NO
 215 USE_PDFLATEX           = NO
 216 LATEX_BATCHMODE        = NO
 217 LATEX_HIDE_INDICES     = NO
 218 #---------------------------------------------------------------------------
 219 # configuration options related to the RTF output
 220 #---------------------------------------------------------------------------
 221 GENERATE_RTF           = NO
 222 RTF_OUTPUT             = rtf
 223 COMPACT_RTF            = NO
 224 RTF_HYPERLINKS         = NO
 225 RTF_STYLESHEET_FILE    =
 226 RTF_EXTENSIONS_FILE    =
 227 #---------------------------------------------------------------------------
 228 # configuration options related to the man page output
 229 #---------------------------------------------------------------------------
 230 GENERATE_MAN           = NO
 231 MAN_OUTPUT             = man
 232 MAN_EXTENSION          = .3
 233 MAN_LINKS              = NO
 234 #---------------------------------------------------------------------------
 235 # configuration options related to the XML output
 236 #---------------------------------------------------------------------------
 237 GENERATE_XML           = NO
 238 XML_OUTPUT             = xml
 239 XML_SCHEMA             =
 240 XML_DTD                =
 241 XML_PROGRAMLISTING     = YES
 242 #---------------------------------------------------------------------------
 243 # configuration options for the AutoGen Definitions output
 244 #---------------------------------------------------------------------------
 245 GENERATE_AUTOGEN_DEF   = NO
 246 #---------------------------------------------------------------------------
 247 # configuration options related to the Perl module output
 248 #---------------------------------------------------------------------------
 249 GENERATE_PERLMOD       = NO
 250 PERLMOD_LATEX          = NO
 251 PERLMOD_PRETTY         = YES
 252 PERLMOD_MAKEVAR_PREFIX =
 253 #---------------------------------------------------------------------------
 254 # Configuration options related to the preprocessor
 255 #---------------------------------------------------------------------------
 256 ENABLE_PREPROCESSING   = YES
 257 MACRO_EXPANSION        = NO
 258 EXPAND_ONLY_PREDEF     = NO
 259 SEARCH_INCLUDES        = YES
 260 INCLUDE_PATH           =
 261 INCLUDE_FILE_PATTERNS  =
 262 PREDEFINED             =
 263 EXPAND_AS_DEFINED      =
 264 SKIP_FUNCTION_MACROS   = YES
 265 #---------------------------------------------------------------------------
 266 # Configuration::additions related to external references
 267 #---------------------------------------------------------------------------
 268 TAGFILES               =
 269 GENERATE_TAGFILE       =
 270 ALLEXTERNALS           = NO
 271 EXTERNAL_GROUPS        = YES
 272 PERL_PATH              = /usr/bin/perl
 273 #---------------------------------------------------------------------------
 274 # Configuration options related to the dot tool
 275 #---------------------------------------------------------------------------
 276 CLASS_DIAGRAMS         = YES
 277 HIDE_UNDOC_RELATIONS   = NO
 278 HAVE_DOT               = YES
 279 CLASS_GRAPH            = YES
 280 COLLABORATION_GRAPH    = YES
 281 GROUP_GRAPHS           = YES
 282 UML_LOOK               = NO
 283 TEMPLATE_RELATIONS     = YES
 284 INCLUDE_GRAPH          = YES
 285 INCLUDED_BY_GRAPH      = YES
 286 CALL_GRAPH             = NO
 287 GRAPHICAL_HIERARCHY    = YES
 288 DIRECTORY_GRAPH        = YES
 289 DOT_IMAGE_FORMAT       = png
 290 DOT_PATH               =
 291 DOTFILE_DIRS           =
 292 MAX_DOT_GRAPH_WIDTH    = 1024
 293 MAX_DOT_GRAPH_HEIGHT   = 1024
 294 MAX_DOT_GRAPH_DEPTH    = 1000
 295 DOT_TRANSPARENT        = NO
 296 DOT_MULTI_TARGETS      = NO
 297 GENERATE_LEGEND        = YES
 298 DOT_CLEANUP            = YES
 299 #---------------------------------------------------------------------------
 300 # Configuration::additions related to the search engine
 301 #---------------------------------------------------------------------------
 302 SEARCHENGINE           = NO