doc/doxygen/Doxyfile_med_user.in

   1 # Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   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 0.1
  21 #---------------------------------------------------------------------------
  22 # General configuration options
  23 #---------------------------------------------------------------------------
  24 #
  25 PROJECT_NAME           = "SALOME MED Users' Guide"
  26 PROJECT_NUMBER         =
  27 OUTPUT_DIRECTORY       = doc_ref_user
  28 OUTPUT_LANGUAGE        = English
  29 EXTRACT_ALL            = YES
  30 EXTRACT_PRIVATE        = NO
  31 EXTRACT_STATIC         = NO
  32 HIDE_UNDOC_MEMBERS     = YES
  33 HIDE_UNDOC_CLASSES     = YES
  34 BRIEF_MEMBER_DESC      = NO
  35 REPEAT_BRIEF           = YES
  36 ALWAYS_DETAILED_SEC    = NO
  37 FULL_PATH_NAMES        = NO
  38 STRIP_FROM_PATH        =
  39 INTERNAL_DOCS          = NO
  40 STRIP_CODE_COMMENTS    = YES
  41 CASE_SENSE_NAMES       = YES
  42 SHORT_NAMES            = NO
  43 HIDE_SCOPE_NAMES       = NO
  44 VERBATIM_HEADERS       = NO
  45 SHOW_INCLUDE_FILES     = NO
  46 JAVADOC_AUTOBRIEF      = NO
  47 INHERIT_DOCS           = YES
  48 MARKDOWN_SUPPORT       = YES
  49 INLINE_INFO            = NO
  50 SORT_MEMBER_DOCS       = NO
  51 DISTRIBUTE_GROUP_DOC   = NO
  52 TAB_SIZE               = 8
  53 GENERATE_TODOLIST      = YES
  54 GENERATE_TESTLIST      = YES
  55 GENERATE_BUGLIST       = YES
  56 ALIASES                =
  57 ENABLED_SECTIONS       = user MEDCOUPLING_ug
  58 MAX_INITIALIZER_LINES  = 30
  59 OPTIMIZE_OUTPUT_FOR_C  = NO
  60 SHOW_USED_FILES        = NO
  61 SORT_BRIEF_DOCS        = YES
  62 #---------------------------------------------------------------------------
  63 # configuration options related to warning and progress messages
  64 #---------------------------------------------------------------------------
  65 QUIET                  = NO
  66 WARNINGS               = YES
  67 WARN_IF_UNDOCUMENTED   = YES
  68 WARN_FORMAT            = "$file:$line: $text"
  69 WARN_LOGFILE           = log_user
  70 #---------------------------------------------------------------------------
  71 # configuration options related to the input files
  72 #---------------------------------------------------------------------------
  73
  74 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/intro.dox \
  75                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/glossary.dox \
  76                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/library.dox \
  77                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medcoupling.dox \
  78                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medloader.dox \
  79                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/interptools.dox \
  80                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/functionalities.dox \
  81                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesPY.dox \
  82                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/gui.dox \
  83                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/tools.dox \
  84                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesCPP.dox \
  85                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medcoupling \
  86                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medloader \
  87                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/interpolation \
  88                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/install.dox \
  89                          @CMAKE_CURRENT_SOURCE_DIR@/fakesources \
  90                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/ParaMEDMEM \
  91                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL \
  92                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL/Bases \
  93                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL/Geometric2D \
  94                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling \
  95                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDLoader
  96
  97 FILE_PATTERNS          = InterpKernelDEC.* \
  98                          OverlapDEC.* \
  99                          DEC.* \
 100                          DisjointDEC.* \
 101                          MPIProcessorGroup.* \
 102                          StructuredCoincidentDEC.* \
 103                          ExplicitCoincidentDEC.* \
 104                          NonCoincidentDEC.* \
 105                          CommInterface.* \
 106                          NormalizedGeometricTypes \
 107                          NormalizedUnstructuredMesh.* \
 108                          Interpolation2D.* \
 109                          Interpolation3D.* \
 110                          Interpolation3DSurf.* \
 111                          InterpolationMatrix.* \
 112                          PlanarIntersector.* \
 113                          TargetIntersector.* \
 114                          Interpolation.* \
 115                          InterpolationOptions.* \
 116                          InterpKernelGeo2DAbstractEdge.* \
 117                          InterpKernelGeo2DEdge.* \
 118                          InterpKernelGeo2DEdgeArcCircle.* \
 119                          InterpKernelGeo2DEdgeLin.* \
 120                          InterpKernelGeo2DComposedEdge.* \
 121                          InterpKernelGeo2DElementaryEdge.* \
 122                          InterpKernelGeo2DNode.* \
 123                          InterpKernelGeo2DQuadraticPolygon.* \
 124                          ParaFIELD.* \
 125                          MEDCouplingMesh.* \
 126                          MEDCouplingUMesh.* \
 127                          MEDCoupling1GTUMesh.* \
 128                          MEDCouplingPointSet.* \
 129                          MEDCouplingCMesh.* \
 130                          MEDCouplingIMesh.* \
 131                          MEDCouplingStructuredMesh.* \
 132                          MEDCouplingCurveLinearMesh.* \
 133                          MEDCouplingExtrudedMesh.* \
 134                          MEDCouplingFieldDouble.* \
 135                          MEDCouplingField.* \
 136                          MEDCouplingNatureOfFieldEnum \
 137                          MEDCouplingNatureOfField.hxx \
 138                          MEDCouplingFieldTemplate.* \
 139                          MEDCouplingFieldDiscretization.* \
 140                          MEDCouplingTimeDiscretization.* \
 141                          MEDCouplingAMRAttribute.* \
 142                          MEDCouplingCartesianAMRMesh.* \
 143                          MEDCouplingTimeLabel.* \
 144                          MEDCouplingRefCountObject.* \
 145                          MEDCouplingMemArray.* \
 146                          MEDCouplingRemapper.* \
 147                          MEDLoader.* \
 148                          MEDFileMesh.* \
 149                          MEDFileField.* \
 150                          *.dox
 151 RECURSIVE              = YES
 152 EXCLUDE                = CVS
 153 EXCLUDE_PATTERNS       = *~
 154 EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../../src/ParaMEDMEM \
 155                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling/Test \
 156                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling_Swig \
 157                          @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDLoader/Swig
 158 EXAMPLE_PATTERNS       = *.cxx *.py
 159 EXAMPLE_RECURSIVE      = NO
 160 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/figures
 161 INPUT_FILTER           =
 162 FILTER_SOURCE_FILES    = NO
 163 #---------------------------------------------------------------------------
 164 # configuration options related to source browsing
 165 #---------------------------------------------------------------------------
 166 SOURCE_BROWSER         = NO
 167 INLINE_SOURCES         = NO
 168 REFERENCED_BY_RELATION = YES
 169 REFERENCES_RELATION    = YES
 170 #---------------------------------------------------------------------------
 171 # configuration options related to the alphabetical class index
 172 #---------------------------------------------------------------------------
 173 ALPHABETICAL_INDEX     = YES
 174 COLS_IN_ALPHA_INDEX    = 5
 175 IGNORE_PREFIX          =
 176 #---------------------------------------------------------------------------
 177 # configuration options related to the HTML output
 178 #---------------------------------------------------------------------------
 179 GENERATE_HTML          = YES
 180 HTML_OUTPUT            = html
 181 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 182 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 183 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
 184 GENERATE_HTMLHELP      = NO
 185 GENERATE_CHI           = YES
 186 BINARY_TOC             = NO
 187 TOC_EXPAND             = YES
 188 DISABLE_INDEX          = NO
 189 ENUM_VALUES_PER_LINE   = 4
 190 GENERATE_TREEVIEW      = YES
 191 TREEVIEW_WIDTH         = 250
 192
 193 #---------------------------------------------------------------------------
 194 #SORT related options
 195 #---------------------------------------------------------------------------
 196 SORT_GROUP_NAMES = NO
 197
 198 #---------------------------------------------------------------------------
 199 # configuration options related to the LaTeX output
 200 #---------------------------------------------------------------------------
 201 GENERATE_LATEX         = YES
 202 LATEX_OUTPUT           = latex
 203 COMPACT_LATEX          = YES
 204 PAPER_TYPE             = a4wide
 205 EXTRA_PACKAGES         =
 206 LATEX_HEADER           =
 207 PDF_HYPERLINKS         = NO
 208 USE_PDFLATEX           = NO
 209 LATEX_BATCHMODE        = NO
 210 #---------------------------------------------------------------------------
 211 # configuration options related to the RTF output
 212 #---------------------------------------------------------------------------
 213 GENERATE_RTF           = NO
 214 RTF_OUTPUT             = rtf
 215 COMPACT_RTF            = NO
 216 RTF_HYPERLINKS         = NO
 217 RTF_STYLESHEET_FILE    =
 218 RTF_EXTENSIONS_FILE    =
 219 #---------------------------------------------------------------------------
 220 # configuration options related to the man page output
 221 #---------------------------------------------------------------------------
 222 GENERATE_MAN           = NO
 223 MAN_OUTPUT             = man
 224 MAN_EXTENSION          = .3
 225 MAN_LINKS              = NO
 226 #---------------------------------------------------------------------------
 227 # configuration options related to the XML output
 228 #---------------------------------------------------------------------------
 229 GENERATE_XML           = YES
 230 XML_OUTPUT             = xml
 231 XML_PROGRAMLISTING     = NO
 232 #---------------------------------------------------------------------------
 233 # Configuration options related to the preprocessor
 234 #---------------------------------------------------------------------------
 235 ENABLE_PREPROCESSING   = YES
 236 MACRO_EXPANSION        = YES
 237 EXPAND_ONLY_PREDEF     = YES
 238 SEARCH_INCLUDES        = YES
 239 INCLUDE_PATH           =
 240 INCLUDE_FILE_PATTERNS  =
 241 PREDEFINED             =
 242 EXPAND_AS_DEFINED      = MEDCOUPLING_EXPORT MEDCOUPLINGREMAPPER_EXPORT MEDLOADER_EXPORT
 243 SKIP_FUNCTION_MACROS   = YES
 244 #---------------------------------------------------------------------------
 245 # Configuration::additions related to external references
 246 #---------------------------------------------------------------------------
 247 TAGFILES               =
 248 GENERATE_TAGFILE       =
 249 ALLEXTERNALS           = NO
 250 PERL_PATH              = /usr/bin/perl
 251 #---------------------------------------------------------------------------
 252 # Configuration options related to the dot tool
 253 #---------------------------------------------------------------------------
 254 CLASS_DIAGRAMS         = YES
 255 HAVE_DOT               = YES
 256 CLASS_GRAPH            = YES
 257 COLLABORATION_GRAPH    = YES
 258 TEMPLATE_RELATIONS     = YES
 259 HIDE_UNDOC_RELATIONS   = YES
 260 INCLUDE_GRAPH          = YES
 261 INCLUDED_BY_GRAPH      = YES
 262 GRAPHICAL_HIERARCHY    = YES
 263 DOT_PATH               =
 264 DOT_FONTNAME           = Arial
 265 DOTFILE_DIRS           =
 266 GENERATE_LEGEND        = YES
 267 DOT_CLEANUP            = YES
 268 #---------------------------------------------------------------------------
 269 # Configuration::additions related to the search engine
 270 #---------------------------------------------------------------------------
 271 SEARCHENGINE           = NO