doc/developer/doxygen/Doxyfile.in

   1 # Doxyfile 0.1
   2 #---------------------------------------------------------------------------
   3 # General configuration options
   4 #---------------------------------------------------------------------------
   5 #
   6 PROJECT_NAME           = "MEDCoupling Developers' Guide"
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = doc_ref_dev
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = YES
  11 EXTRACT_PRIVATE        = NO
  12 EXTRACT_STATIC         = NO
  13 HIDE_UNDOC_MEMBERS     = YES
  14 HIDE_UNDOC_CLASSES     = YES
  15 BRIEF_MEMBER_DESC      = NO
  16 REPEAT_BRIEF           = YES
  17 ALWAYS_DETAILED_SEC    = NO
  18 FULL_PATH_NAMES        = NO
  19 STRIP_FROM_PATH        =
  20 INTERNAL_DOCS          = NO
  21 STRIP_CODE_COMMENTS    = YES
  22 CASE_SENSE_NAMES       = YES
  23 SHORT_NAMES            = NO
  24 HIDE_SCOPE_NAMES       = NO
  25 VERBATIM_HEADERS       = NO
  26 SHOW_INCLUDE_FILES     = NO
  27 JAVADOC_AUTOBRIEF      = NO
  28 INHERIT_DOCS           = YES
  29 MARKDOWN_SUPPORT       = YES
  30 INLINE_INFO            = NO
  31 SORT_MEMBER_DOCS       = NO
  32 DISTRIBUTE_GROUP_DOC   = NO
  33 TAB_SIZE               = 8
  34 GENERATE_TODOLIST      = YES
  35 GENERATE_TESTLIST      = YES
  36 GENERATE_BUGLIST       = YES
  37 ALIASES                =
  38 ENABLED_SECTIONS       = user MEDCOUPLING_ug
  39 MAX_INITIALIZER_LINES  = 30
  40 OPTIMIZE_OUTPUT_FOR_C  = NO
  41 SHOW_USED_FILES        = NO
  42 SORT_BRIEF_DOCS        = YES
  43 #---------------------------------------------------------------------------
  44 # configuration options related to warning and progress messages
  45 #---------------------------------------------------------------------------
  46 QUIET                  = NO
  47 WARNINGS               = YES
  48 WARN_IF_UNDOCUMENTED   = YES
  49 WARN_FORMAT            = "$file:$line: $text"
  50 WARN_LOGFILE           = log_dev
  51 #---------------------------------------------------------------------------
  52 # configuration options related to the input files
  53 #---------------------------------------------------------------------------
  54
  55 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/index.dox \
  56                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/faq.dox \
  57                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/start \
  58                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/tutorial.dox \
  59                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference \
  60                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/arrays \
  61                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/meshes \
  62                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/fields \
  63                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/medloader \
  64                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/interpolation \
  65                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/cpp \
  66                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/distrib \
  67                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/misc \
  68                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/examples/examples.dox \
  69                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesPY.dox \
  70                          @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesCPP.dox \
  71                          @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/appendix \
  72                          @CMAKE_CURRENT_SOURCE_DIR@/fakesources \
  73                          @CMAKE_SOURCE_DIR@/src/ParaMEDMEM \
  74                          @CMAKE_SOURCE_DIR@/src/INTERP_KERNEL \
  75                          @CMAKE_SOURCE_DIR@/src/INTERP_KERNEL/Bases \
  76                          @CMAKE_SOURCE_DIR@/src/INTERP_KERNEL/Geometric2D \
  77                          @CMAKE_SOURCE_DIR@/src/MEDCoupling \
  78                          @CMAKE_SOURCE_DIR@/src/ICoCo \
  79                          @CMAKE_SOURCE_DIR@/src/MEDLoader
  80
  81 FILE_PATTERNS          = InterpKernelDEC.*xx \
  82                          OverlapDEC.*xx \
  83                          DEC.*xx \
  84                          DECOptions.*xx \
  85                          DisjointDEC.*xx \
  86                          *Topology.*xx \
  87                          MPIProcessorGroup.*xx \
  88                          ProcessorGroup.*xx \
  89                          MPIAccess.*xx \
  90                          StructuredCoincidentDEC.*xx \
  91                          ExplicitCoincidentDEC.*xx \
  92                          NonCoincidentDEC.*xx \
  93                          CommInterface.*xx \
  94                          NormalizedGeometricTypes \
  95                          NormalizedUnstructuredMesh.*xx \
  96                          Interpolation2D.*xx \
  97                          Interpolation3D.*xx \
  98                          Interpolation3DSurf.*xx \
  99                          InterpolationMatrix.*xx \
 100                          PlanarIntersector.*xx \
 101                          TargetIntersector.*xx \
 102                          Interpolation.*xx \
 103                          InterpolationOptions.*xx \
 104                          InterpKernelGeo2DAbstractEdge.*xx \
 105                          InterpKernelGeo2DEdge.*xx \
 106                          InterpKernelGeo2DEdgeArcCircle.*xx \
 107                          InterpKernelGeo2DEdgeLin.*xx \
 108                          InterpKernelGeo2DComposedEdge.*xx \
 109                          InterpKernelGeo2DElementaryEdge.*xx \
 110                          InterpKernelGeo2DNode.*xx \
 111                          InterpKernelGeo2DQuadraticPolygon.*xx \
 112                          ParaFIELD.*xx \
 113                          ParaMESH.*xx \
 114                          MEDCouplingMesh.*xx \
 115                          MEDCouplingUMesh.*xx \
 116                          MEDCouplingUMesh_intersection.*xx \
 117                          MEDCoupling1GTUMesh.*xx \
 118                          MEDCouplingPointSet.*xx \
 119                          MEDCouplingCMesh.*xx \
 120                          MEDCouplingIMesh.*xx \
 121                          MEDCouplingStructuredMesh.*xx \
 122                          MEDCouplingCurveLinearMesh.*xx \
 123                          MEDCouplingMappedExtrudedMesh.*xx \
 124                          MEDCouplingFieldDouble.*xx \
 125                          MEDCouplingFieldInt.*xx \
 126                          MEDCouplingFieldT.*xx \
 127                          MEDCouplingField.*xx \
 128                          MEDCouplingNatureOfFieldEnum \
 129                          MEDCouplingNatureOfField.hxx \
 130                          MEDCouplingFieldTemplate.*xx \
 131                          MEDCouplingFieldDiscretization.*xx \
 132                          MEDCouplingTimeDiscretization.*xx \
 133                          MEDCouplingAMRAttribute.*xx \
 134                          MEDCouplingCartesianAMRMesh.*xx \
 135                          MEDCouplingTimeLabel.*xx \
 136                          MEDCouplingRefCountObject.*xx \
 137                          MEDCouplingMemArray.*xx \
 138                          MEDCouplingGaussLocalization.*xx \
 139                          MEDCouplingRemapper.*xx \
 140                          MEDLoader.*xx \
 141                          MEDFileData.*xx \
 142                          MEDFileParameter.*xx \
 143                          MEDFileMesh.*xx \
 144                          MEDFileFieldGlobs.*xx \
 145                          MEDFileFieldInternal.*xx \
 146                          MEDFileField1TS.*xx \
 147                          MEDFileFieldMultiTS.*xx \
 148                          MEDFileField.*xx \
 149                          MEDFileFieldVisitor.hxx \
 150                          *Servant.*xx \
 151                          ICoCo*.hxx \
 152                          *.dox
 153 EXTENSION_MAPPING      = txx=C++
 154 RECURSIVE              = YES
 155 EXCLUDE                = CVS
 156 EXCLUDE_PATTERNS       = *~
 157 EXCLUDE_SYMBOLS        =
 158 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/src/ParaMEDMEM \
 159                          @CMAKE_SOURCE_DIR@/src/MEDCoupling/Test \
 160                          @CMAKE_SOURCE_DIR@/src/MEDCoupling_Swig \
 161                          @CMAKE_SOURCE_DIR@/src/MEDLoader/Swig
 162 EXAMPLE_PATTERNS       = *.cxx *.py
 163 EXAMPLE_RECURSIVE      = NO
 164 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/figures
 165 INPUT_FILTER           =
 166 FILTER_SOURCE_FILES    = NO
 167 #---------------------------------------------------------------------------
 168 # configuration options related to source browsing
 169 #---------------------------------------------------------------------------
 170 SOURCE_BROWSER         = NO
 171 INLINE_SOURCES         = NO
 172 REFERENCED_BY_RELATION = YES
 173 REFERENCES_RELATION    = YES
 174 #---------------------------------------------------------------------------
 175 # configuration options related to the alphabetical class index
 176 #---------------------------------------------------------------------------
 177 ALPHABETICAL_INDEX     = YES
 178 COLS_IN_ALPHA_INDEX    = 5
 179 IGNORE_PREFIX          =
 180 #---------------------------------------------------------------------------
 181 # configuration options related to the HTML output
 182 #---------------------------------------------------------------------------
 183 GENERATE_HTML          = YES
 184 HTML_OUTPUT            = html
 185 HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
 186 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
 187 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/medcoupling_extra.css
 188 HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
 189 GENERATE_HTMLHELP      = NO
 190 GENERATE_CHI           = YES
 191 BINARY_TOC             = NO
 192 TOC_EXPAND             = YES
 193 DISABLE_INDEX          = NO
 194 ENUM_VALUES_PER_LINE   = 4
 195 GENERATE_TREEVIEW      = YES
 196 TREEVIEW_WIDTH         = 250
 197
 198 #---------------------------------------------------------------------------
 199 #SORT related options
 200 #---------------------------------------------------------------------------
 201 SORT_GROUP_NAMES = NO
 202
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the LaTeX output
 205 #---------------------------------------------------------------------------
 206 GENERATE_LATEX         = YES
 207 LATEX_OUTPUT           = latex
 208 COMPACT_LATEX          = YES
 209 PAPER_TYPE             = a4wide
 210 EXTRA_PACKAGES         =
 211 LATEX_HEADER           =
 212 PDF_HYPERLINKS         = NO
 213 USE_PDFLATEX           = NO
 214 LATEX_BATCHMODE        = NO
 215 #---------------------------------------------------------------------------
 216 # configuration options related to the RTF output
 217 #---------------------------------------------------------------------------
 218 GENERATE_RTF           = NO
 219 RTF_OUTPUT             = rtf
 220 COMPACT_RTF            = NO
 221 RTF_HYPERLINKS         = NO
 222 RTF_STYLESHEET_FILE    =
 223 RTF_EXTENSIONS_FILE    =
 224 #---------------------------------------------------------------------------
 225 # configuration options related to the man page output
 226 #---------------------------------------------------------------------------
 227 GENERATE_MAN           = NO
 228 MAN_OUTPUT             = man
 229 MAN_EXTENSION          = .3
 230 MAN_LINKS              = NO
 231 #---------------------------------------------------------------------------
 232 # configuration options related to the XML output
 233 #---------------------------------------------------------------------------
 234 GENERATE_XML           = YES
 235 XML_OUTPUT             = xml
 236 XML_PROGRAMLISTING     = NO
 237 #---------------------------------------------------------------------------
 238 # Configuration options related to the preprocessor
 239 #---------------------------------------------------------------------------
 240 ENABLE_PREPROCESSING   = YES
 241 MACRO_EXPANSION        = YES
 242 EXPAND_ONLY_PREDEF     = YES
 243 SEARCH_INCLUDES        = YES
 244 INCLUDE_PATH           =
 245 INCLUDE_FILE_PATTERNS  =
 246 PREDEFINED             =
 247 EXPAND_AS_DEFINED      = MEDCOUPLING_EXPORT MEDCOUPLINGREMAPPER_EXPORT MEDLOADER_EXPORT
 248 SKIP_FUNCTION_MACROS   = YES
 249 #---------------------------------------------------------------------------
 250 # Configuration::additions related to external references
 251 #---------------------------------------------------------------------------
 252 TAGFILES               =
 253 GENERATE_TAGFILE       =
 254 ALLEXTERNALS           = NO
 255 PERL_PATH              = /usr/bin/perl
 256 #---------------------------------------------------------------------------
 257 # Configuration options related to the dot tool
 258 #---------------------------------------------------------------------------
 259 CLASS_DIAGRAMS         = YES
 260 HAVE_DOT               = YES
 261 CLASS_GRAPH            = YES
 262 COLLABORATION_GRAPH    = YES
 263 TEMPLATE_RELATIONS     = YES
 264 HIDE_UNDOC_RELATIONS   = YES
 265 INCLUDE_GRAPH          = YES
 266 INCLUDED_BY_GRAPH      = YES
 267 GRAPHICAL_HIERARCHY    = YES
 268 DOT_PATH               =
 269 DOT_FONTNAME           = Arial
 270 DOTFILE_DIRS           =
 271 GENERATE_LEGEND        = YES
 272 DOT_CLEANUP            = YES
 273 #---------------------------------------------------------------------------
 274 # Configuration::additions related to the search engine
 275 #---------------------------------------------------------------------------
 276 SEARCHENGINE           = YES
 277 SERVER_BASED_SEARCH    = @MEDCOUPLING_SERVER_BASED_SEARCH@
 278 EXTERNAL_SEARCH        = NO