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