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