doc/Doxyfile.in

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