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