doc/user/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           = "MEDCoupling 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/index.dox \
  75                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/faq.dox \
  76                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/start \
  77                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/tutorial.dox \
  78                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference \
  79                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/arrays \
  80                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/meshes \
  81                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/fields \
  82                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/medloader \
  83                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/interpolation \
  84                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/cpp \
  85                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/distrib \
  86                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/misc \
  87                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/examples/examples.dox \
  88                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesPY.dox \
  89                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesCPP.dox \
  90                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/appendix \
  91                          @CMAKE_CURRENT_SOURCE_DIR@/fakesources \
  92                          @PROJECT_SOURCE_DIR@/src/ParaMEDMEM \
  93                          @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL \
  94                          @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Bases \
  95                          @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Geometric2D \
  96                          @PROJECT_SOURCE_DIR@/src/MEDCoupling \
  97                          @PROJECT_SOURCE_DIR@/src/MEDLoader
  98
  99 FILE_PATTERNS          = InterpKernelDEC.* \
 100                          OverlapDEC.* \
 101                          DEC.* \
 102                          DECOptions.* \
 103                          DisjointDEC.* \
 104                          *Topology.* \
 105                          MPIProcessorGroup.* \
 106                          ProcessorGroup.* \
 107                          MPIAccess.* \
 108                          StructuredCoincidentDEC.* \
 109                          ExplicitCoincidentDEC.* \
 110                          NonCoincidentDEC.* \
 111                          CommInterface.* \
 112                          ICoCo*.* \
 113                          NormalizedGeometricTypes \
 114                          NormalizedUnstructuredMesh.* \
 115                          Interpolation2D.* \
 116                          Interpolation3D.* \
 117                          Interpolation3DSurf.* \
 118                          InterpolationMatrix.* \
 119                          PlanarIntersector.* \
 120                          TargetIntersector.* \
 121                          Interpolation.* \
 122                          InterpolationOptions.* \
 123                          InterpKernelGeo2DAbstractEdge.* \
 124                          InterpKernelGeo2DEdge.* \
 125                          InterpKernelGeo2DEdgeArcCircle.* \
 126                          InterpKernelGeo2DEdgeLin.* \
 127                          InterpKernelGeo2DComposedEdge.* \
 128                          InterpKernelGeo2DElementaryEdge.* \
 129                          InterpKernelGeo2DNode.* \
 130                          InterpKernelGeo2DQuadraticPolygon.* \
 131                          ParaFIELD.* \
 132                          ParaMESH.* \
 133                          MEDCouplingMesh.* \
 134                          MEDCouplingUMesh.* \
 135                          MEDCoupling1GTUMesh.* \
 136                          MEDCouplingPointSet.* \
 137                          MEDCouplingCMesh.* \
 138                          MEDCouplingIMesh.* \
 139                          MEDCouplingStructuredMesh.* \
 140                          MEDCouplingCurveLinearMesh.* \
 141                          MEDCouplingExtrudedMesh.* \
 142                          MEDCouplingFieldDouble.* \
 143                          MEDCouplingField.* \
 144                          MEDCouplingNatureOfFieldEnum \
 145                          MEDCouplingNatureOfField.hxx \
 146                          MEDCouplingFieldTemplate.* \
 147                          MEDCouplingFieldDiscretization.* \
 148                          MEDCouplingTimeDiscretization.* \
 149                          MEDCouplingAMRAttribute.* \
 150                          MEDCouplingCartesianAMRMesh.* \
 151                          MEDCouplingTimeLabel.* \
 152                          MEDCouplingRefCountObject.* \
 153                          MEDCouplingAutoRefCountObjectPtr.* \
 154                          MEDCouplingMemArray.* \
 155                          MEDCouplingGaussLocalization.* \
 156                          MEDCouplingRemapper.* \
 157                          MEDLoader.* \
 158                          MEDFileData.* \
 159                          MEDFileParameter.* \
 160                          MEDFileMesh.* \
 161                          MEDFileField.* \
 162                          *Servant.* \
 163                          *.dox
 164 RECURSIVE              = YES
 165 EXCLUDE                = CVS
 166 EXCLUDE_PATTERNS       = *~
 167 EXAMPLE_PATH           = @PROJECT_SOURCE_DIR@/src/ParaMEDMEM \
 168                          @PROJECT_SOURCE_DIR@/src/MEDCoupling/Test \
 169                          @PROJECT_SOURCE_DIR@/src/MEDCoupling_Swig \
 170                          @PROJECT_SOURCE_DIR@/src/MEDLoader/Swig
 171 EXAMPLE_PATTERNS       = *.cxx *.py
 172 EXAMPLE_RECURSIVE      = NO
 173 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/figures
 174 INPUT_FILTER           =
 175 FILTER_SOURCE_FILES    = NO
 176 #---------------------------------------------------------------------------
 177 # configuration options related to source browsing
 178 #---------------------------------------------------------------------------
 179 SOURCE_BROWSER         = NO
 180 INLINE_SOURCES         = NO
 181 REFERENCED_BY_RELATION = YES
 182 REFERENCES_RELATION    = YES
 183 #---------------------------------------------------------------------------
 184 # configuration options related to the alphabetical class index
 185 #---------------------------------------------------------------------------
 186 ALPHABETICAL_INDEX     = YES
 187 COLS_IN_ALPHA_INDEX    = 5
 188 IGNORE_PREFIX          =
 189 #---------------------------------------------------------------------------
 190 # configuration options related to the HTML output
 191 #---------------------------------------------------------------------------
 192 GENERATE_HTML          = YES
 193 HTML_OUTPUT            = html
 194 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 195 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 196 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/medcoupling_extra.css
 197 GENERATE_HTMLHELP      = NO
 198 GENERATE_CHI           = YES
 199 BINARY_TOC             = NO
 200 TOC_EXPAND             = YES
 201 DISABLE_INDEX          = NO
 202 ENUM_VALUES_PER_LINE   = 4
 203 GENERATE_TREEVIEW      = YES
 204 TREEVIEW_WIDTH         = 250
 205
 206 #---------------------------------------------------------------------------
 207 #SORT related options
 208 #---------------------------------------------------------------------------
 209 SORT_GROUP_NAMES = NO
 210
 211 #---------------------------------------------------------------------------
 212 # configuration options related to the LaTeX output
 213 #---------------------------------------------------------------------------
 214 GENERATE_LATEX         = YES
 215 LATEX_OUTPUT           = latex
 216 COMPACT_LATEX          = YES
 217 PAPER_TYPE             = a4wide
 218 EXTRA_PACKAGES         =
 219 LATEX_HEADER           =
 220 PDF_HYPERLINKS         = NO
 221 USE_PDFLATEX           = NO
 222 LATEX_BATCHMODE        = NO
 223 #---------------------------------------------------------------------------
 224 # configuration options related to the RTF output
 225 #---------------------------------------------------------------------------
 226 GENERATE_RTF           = NO
 227 RTF_OUTPUT             = rtf
 228 COMPACT_RTF            = NO
 229 RTF_HYPERLINKS         = NO
 230 RTF_STYLESHEET_FILE    =
 231 RTF_EXTENSIONS_FILE    =
 232 #---------------------------------------------------------------------------
 233 # configuration options related to the man page output
 234 #---------------------------------------------------------------------------
 235 GENERATE_MAN           = NO
 236 MAN_OUTPUT             = man
 237 MAN_EXTENSION          = .3
 238 MAN_LINKS              = NO
 239 #---------------------------------------------------------------------------
 240 # configuration options related to the XML output
 241 #---------------------------------------------------------------------------
 242 GENERATE_XML           = YES
 243 XML_OUTPUT             = xml
 244 XML_PROGRAMLISTING     = NO
 245 #---------------------------------------------------------------------------
 246 # Configuration options related to the preprocessor
 247 #---------------------------------------------------------------------------
 248 ENABLE_PREPROCESSING   = YES
 249 MACRO_EXPANSION        = YES
 250 EXPAND_ONLY_PREDEF     = YES
 251 SEARCH_INCLUDES        = YES
 252 INCLUDE_PATH           =
 253 INCLUDE_FILE_PATTERNS  =
 254 PREDEFINED             =
 255 EXPAND_AS_DEFINED      = MEDCOUPLING_EXPORT MEDCOUPLINGREMAPPER_EXPORT MEDLOADER_EXPORT
 256 SKIP_FUNCTION_MACROS   = YES
 257 #---------------------------------------------------------------------------
 258 # Configuration::additions related to external references
 259 #---------------------------------------------------------------------------
 260 TAGFILES               =
 261 GENERATE_TAGFILE       =
 262 ALLEXTERNALS           = NO
 263 PERL_PATH              = /usr/bin/perl
 264 #---------------------------------------------------------------------------
 265 # Configuration options related to the dot tool
 266 #---------------------------------------------------------------------------
 267 CLASS_DIAGRAMS         = YES
 268 HAVE_DOT               = YES
 269 CLASS_GRAPH            = YES
 270 COLLABORATION_GRAPH    = YES
 271 TEMPLATE_RELATIONS     = YES
 272 HIDE_UNDOC_RELATIONS   = YES
 273 INCLUDE_GRAPH          = YES
 274 INCLUDED_BY_GRAPH      = YES
 275 GRAPHICAL_HIERARCHY    = YES
 276 DOT_PATH               =
 277 DOT_FONTNAME           = Arial
 278 DOTFILE_DIRS           =
 279 GENERATE_LEGEND        = YES
 280 DOT_CLEANUP            = YES
 281 #---------------------------------------------------------------------------
 282 # Configuration::additions related to the search engine
 283 #---------------------------------------------------------------------------
 284 SEARCHENGINE           = YES