doc/doxygen/Doxyfile_med_user.in

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