doc/salome/gui/doxyfile.in

   1 # Copyright (C) 2010-2014  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, 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.6
  21
  22 #---------------------------------------------------------------------------
  23 # Project related configuration options
  24 #---------------------------------------------------------------------------
  25 PROJECT_NAME           = "ParaViS Module v.@SALOMEPARAVIS_VERSION@"
  26 PROJECT_NUMBER         =
  27 OUTPUT_DIRECTORY       = PARAVIS
  28 CREATE_SUBDIRS         = NO
  29 OUTPUT_LANGUAGE        = English
  30 USE_WINDOWS_ENCODING   = NO
  31 BRIEF_MEMBER_DESC      = YES
  32 REPEAT_BRIEF           = NO
  33 ABBREVIATE_BRIEF       =
  34 ALWAYS_DETAILED_SEC    = YES
  35 INLINE_INHERITED_MEMB  = YES
  36 FULL_PATH_NAMES        = YES
  37 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@
  38 STRIP_FROM_INC_PATH    =
  39 SHORT_NAMES            = NO
  40 JAVADOC_AUTOBRIEF      = YES
  41 MULTILINE_CPP_IS_BRIEF = NO
  42 DETAILS_AT_TOP         = NO
  43 INHERIT_DOCS           = YES
  44 SEPARATE_MEMBER_PAGES  = NO
  45 TAB_SIZE               = 5
  46 ALIASES                =
  47 OPTIMIZE_OUTPUT_FOR_C  = YES
  48 OPTIMIZE_OUTPUT_JAVA   = YES
  49 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
  50 DISTRIBUTE_GROUP_DOC   = NO
  51 SUBGROUPING            = YES
  52
  53 #---------------------------------------------------------------------------
  54 # Build related configuration options
  55 #---------------------------------------------------------------------------
  56 EXTRACT_ALL            = YES
  57 EXTRACT_PRIVATE        = YES
  58 EXTRACT_STATIC         = YES
  59 EXTRACT_LOCAL_CLASSES  = YES
  60 EXTRACT_LOCAL_METHODS  = NO
  61 HIDE_UNDOC_MEMBERS     = NO
  62 HIDE_UNDOC_CLASSES     = NO
  63 HIDE_FRIEND_COMPOUNDS  = NO
  64 HIDE_IN_BODY_DOCS      = NO
  65 INTERNAL_DOCS          = YES
  66 CASE_SENSE_NAMES       = YES
  67 HIDE_SCOPE_NAMES       = NO
  68 SHOW_INCLUDE_FILES     = YES
  69 INLINE_INFO            = YES
  70 SORT_MEMBER_DOCS       = NO
  71 SORT_BRIEF_DOCS        = NO
  72 SORT_BY_SCOPE_NAME     = NO
  73 GENERATE_TODOLIST      = YES
  74 GENERATE_TESTLIST      = YES
  75 GENERATE_BUGLIST       = YES
  76 GENERATE_DEPRECATEDLIST= YES
  77 ENABLED_SECTIONS       =
  78 MAX_INITIALIZER_LINES  = 25
  79 SHOW_USED_FILES        = NO
  80 SHOW_DIRECTORIES       = NO
  81 FILE_VERSION_FILTER    =
  82
  83 #---------------------------------------------------------------------------
  84 # configuration options related to warning and progress messages
  85 #---------------------------------------------------------------------------
  86 QUIET                  = NO
  87 WARNINGS               = YES
  88 WARN_IF_UNDOCUMENTED   = YES
  89 WARN_IF_DOC_ERROR      = YES
  90 WARN_NO_PARAMDOC       = NO
  91 WARN_FORMAT            = "$file:$line: $text"
  92 WARN_LOGFILE           =
  93
  94 #---------------------------------------------------------------------------
  95 # configuration options related to the input files
  96 #---------------------------------------------------------------------------
  97 INPUT                  = @CMAKE_SOURCE_DIR@/src \
  98                          @CMAKE_SOURCE_DIR@/bin \
  99                          @CMAKE_BINARY_DIR@/bin
 100 FILE_PATTERNS          = *.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      = NO
 108 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/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            = @CMAKE_CURRENT_SOURCE_DIR@/static/myheader.html
 138 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 139 HTML_STYLESHEET        = @CMAKE_CURRENT_SOURCE_DIR@/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        = NO
 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_FONTNAME           = Arial
 248 DOT_PATH               =
 249 DOTFILE_DIRS           =
 250 MAX_DOT_GRAPH_WIDTH    = 1024
 251 MAX_DOT_GRAPH_HEIGHT   = 1200
 252 MAX_DOT_GRAPH_DEPTH    = 0
 253 DOT_TRANSPARENT        = NO
 254 DOT_MULTI_TARGETS      = NO
 255 GENERATE_LEGEND        = NO
 256 DOT_CLEANUP            = YES
 257
 258 #---------------------------------------------------------------------------
 259 # Configuration::additions related to the search engine
 260 #---------------------------------------------------------------------------
 261 SEARCHENGINE           = NO