doc/doxygen/Doxyfile_med_user.in

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