doc/doxygen/Doxyfile_med_user.in

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