doc/user/doxygen/Doxyfile_med_user.in

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