Salome HOME
Debug of CMake build procedure
[tools/medcoupling.git] / doc / doxygen / Doxyfile_med_user.in
index bbd06e6d3ff5848f970d03b36febb36099fb26ac..18b827dd7838b20b6443b34817deb13c1177a97e 100644 (file)
@@ -1,31 +1,29 @@
-#  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
 #
-#  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-#  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
 #
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License.
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
 #
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 #
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
-#
-#  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
+
 # Doxyfile 0.1
 #---------------------------------------------------------------------------
 # General configuration options
 #---------------------------------------------------------------------------
 #
-PROJECT_NAME           = "Med Memory Users' Guide"
-PROJECT_NUMBER         = @VERSION@
+PROJECT_NAME           = "SALOME MED Users' Guide"
+PROJECT_NUMBER         =
 OUTPUT_DIRECTORY       = doc_ref_user
 OUTPUT_LANGUAGE        = English
 EXTRACT_ALL            = YES
@@ -37,7 +35,7 @@ BRIEF_MEMBER_DESC      = NO
 REPEAT_BRIEF           = YES
 ALWAYS_DETAILED_SEC    = NO
 FULL_PATH_NAMES        = NO
-STRIP_FROM_PATH        = 
+STRIP_FROM_PATH        =
 INTERNAL_DOCS          = NO
 STRIP_CODE_COMMENTS    = YES
 CASE_SENSE_NAMES       = YES
@@ -47,6 +45,7 @@ VERBATIM_HEADERS       = NO
 SHOW_INCLUDE_FILES     = NO
 JAVADOC_AUTOBRIEF      = NO
 INHERIT_DOCS           = YES
+MARKDOWN_SUPPORT       = YES
 INLINE_INFO            = NO
 SORT_MEMBER_DOCS       = NO
 DISTRIBUTE_GROUP_DOC   = NO
@@ -54,8 +53,8 @@ TAB_SIZE               = 8
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
-ALIASES                = 
-ENABLED_SECTIONS       = user MEDMEM_ug
+ALIASES                =
+ENABLED_SECTIONS       = user MEDCOUPLING_ug
 MAX_INITIALIZER_LINES  = 30
 OPTIMIZE_OUTPUT_FOR_C  = NO
 SHOW_USED_FILES        = NO
@@ -70,25 +69,41 @@ WARN_LOGFILE           = log_user
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @srcdir@ \
-                         @srcdir@/../../src/ParaMEDMEM \
-                         @srcdir@/../../src/INTERP_KERNEL \
-                         @srcdir@/../../src/INTERP_KERNEL/Geometric2D \
-                         @srcdir@/../../src/MEDMEM
 
-FILE_PATTERNS          = MEDMEM_Mesh.* \
-                         MEDMEM_Grid.* \
-                         MEDMEM_Meshing.* \
-                         MEDMEM_Support.* \
-                         MEDMEM_Field.* \
-                         MEDMEM_Med.* \
-                         IntersectionDEC.* \
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/intro.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/glossary.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/library.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medcoupling.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medloader.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/interptools.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/functionalities.dox \
+                         @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesPY.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/gui.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/tools.dox \
+                         @CMAKE_CURRENT_BINARY_DIR@/medcouplingexamplesCPP.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medcoupling \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/medloader \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/interpolation \
+                         @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/install.dox \
+                         @CMAKE_CURRENT_SOURCE_DIR@/fakesources \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/ParaMEDMEM \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL/Bases \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/INTERP_KERNEL/Geometric2D \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDLoader
+
+FILE_PATTERNS          = InterpKernelDEC.* \
+                         OverlapDEC.* \
                          DEC.* \
+                         DisjointDEC.* \
                          MPIProcessorGroup.* \
                          StructuredCoincidentDEC.* \
                          ExplicitCoincidentDEC.* \
                          NonCoincidentDEC.* \
                          CommInterface.* \
+                         NormalizedGeometricTypes \
+                         NormalizedUnstructuredMesh.* \
                          Interpolation2D.* \
                          Interpolation3D.* \
                          Interpolation3DSurf.* \
@@ -96,26 +111,50 @@ FILE_PATTERNS          = MEDMEM_Mesh.* \
                          PlanarIntersector.* \
                          TargetIntersector.* \
                          Interpolation.* \
-                         AbstractEdge.* \
-                         Edge.* \
-                         EdgeArcCircle.* \
-                         EdgeLin.* \
-                         ComposedEdge.* \
-                         ElementaryEdge.* \
-                         Node.* \
-                         QuadraticPolygon.* \
+                         InterpolationOptions.* \
+                         InterpKernelGeo2DAbstractEdge.* \
+                         InterpKernelGeo2DEdge.* \
+                         InterpKernelGeo2DEdgeArcCircle.* \
+                         InterpKernelGeo2DEdgeLin.* \
+                         InterpKernelGeo2DComposedEdge.* \
+                         InterpKernelGeo2DElementaryEdge.* \
+                         InterpKernelGeo2DNode.* \
+                         InterpKernelGeo2DQuadraticPolygon.* \
                          ParaFIELD.* \
+                         MEDCouplingMesh.* \
+                         MEDCouplingUMesh.* \
+                         MEDCoupling1GTUMesh.* \
+                         MEDCouplingPointSet.* \
+                         MEDCouplingCMesh.* \
+                         MEDCouplingStructuredMesh.* \
+                         MEDCouplingCurveLinearMesh.* \
+                         MEDCouplingExtrudedMesh.* \
+                         MEDCouplingFieldDouble.* \
+                         MEDCouplingField.* \
+                         MEDCouplingNatureOfFieldEnum \
+                         MEDCouplingNatureOfField.hxx \
+                         MEDCouplingFieldTemplate.* \
+                         MEDCouplingFieldDiscretization.* \
+                         MEDCouplingTimeDiscretization.* \
+                         MEDCouplingTimeLabel.* \
+                         MEDCouplingRefCountObject.* \
+                         MEDCouplingMemArray.* \
+                         MEDCouplingRemapper.* \
+                         MEDLoader.* \
+                         MEDFileMesh.* \
+                         MEDFileField.* \
                          *.dox
-RECURSIVE              = NO
+RECURSIVE              = YES
 EXCLUDE                = CVS
 EXCLUDE_PATTERNS       = *~
-EXAMPLE_PATH           = @srcdir@/../../src/ParaMEDMEM/ \
-                         @srcdir@/../../doc/MEDMEM \
-                         @srcdir@/../../src/MEDMEM
+EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/../../src/ParaMEDMEM \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling/Test \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDCoupling_Swig \
+                         @CMAKE_CURRENT_SOURCE_DIR@/../../src/MEDLoader/Swig
 EXAMPLE_PATTERNS       = *.cxx *.py
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = @srcdir@/figures
-INPUT_FILTER           = 
+IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/figures
+INPUT_FILTER           =
 FILTER_SOURCE_FILES    = NO
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
@@ -129,17 +168,16 @@ REFERENCES_RELATION    = YES
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = YES
 COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          = 
+IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
 #---------------------------------------------------------------------------
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
-HTML_HEADER            = 
-HTML_FOOTER            = 
-HTML_STYLESHEET        = 
-HTML_ALIGN_MEMBERS     = YES
-GENERATE_HTMLHELP      = YES
+HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/static/header.html
+HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
+HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
+GENERATE_HTMLHELP      = NO
 GENERATE_CHI           = YES
 BINARY_TOC             = NO
 TOC_EXPAND             = YES
@@ -147,6 +185,12 @@ DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 4
 GENERATE_TREEVIEW      = YES
 TREEVIEW_WIDTH         = 250
+
+#---------------------------------------------------------------------------
+#SORT related options
+#---------------------------------------------------------------------------
+SORT_GROUP_NAMES = NO
+
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
@@ -154,8 +198,8 @@ GENERATE_LATEX         = YES
 LATEX_OUTPUT           = latex
 COMPACT_LATEX          = YES
 PAPER_TYPE             = a4wide
-EXTRA_PACKAGES         = 
-LATEX_HEADER           = 
+EXTRA_PACKAGES         =
+LATEX_HEADER           =
 PDF_HYPERLINKS         = NO
 USE_PDFLATEX           = NO
 LATEX_BATCHMODE        = NO
@@ -166,8 +210,8 @@ GENERATE_RTF           = NO
 RTF_OUTPUT             = rtf
 COMPACT_RTF            = NO
 RTF_HYPERLINKS         = NO
-RTF_STYLESHEET_FILE    = 
-RTF_EXTENSIONS_FILE    = 
+RTF_STYLESHEET_FILE    =
+RTF_EXTENSIONS_FILE    =
 #---------------------------------------------------------------------------
 # configuration options related to the man page output
 #---------------------------------------------------------------------------
@@ -180,26 +224,26 @@ MAN_LINKS              = NO
 #---------------------------------------------------------------------------
 GENERATE_XML           = NO
 #---------------------------------------------------------------------------
-# Configuration options related to the preprocessor   
+# Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = NO
-EXPAND_ONLY_PREDEF     = NO
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
 SEARCH_INCLUDES        = YES
-INCLUDE_PATH           = 
-INCLUDE_FILE_PATTERNS  = 
-PREDEFINED             = 
-EXPAND_AS_DEFINED      = 
+INCLUDE_PATH           =
+INCLUDE_FILE_PATTERNS  =
+PREDEFINED             =
+EXPAND_AS_DEFINED      = MEDCOUPLING_EXPORT MEDCOUPLINGREMAPPER_EXPORT MEDLOADER_EXPORT
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
-# Configuration::addtions related to external references   
+# Configuration::additions related to external references
 #---------------------------------------------------------------------------
-TAGFILES               = 
-GENERATE_TAGFILE       = 
+TAGFILES               =
+GENERATE_TAGFILE       =
 ALLEXTERNALS           = NO
 PERL_PATH              = /usr/bin/perl
 #---------------------------------------------------------------------------
-# Configuration options related to the dot tool   
+# Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 CLASS_DIAGRAMS         = YES
 HAVE_DOT               = YES
@@ -210,19 +254,12 @@ HIDE_UNDOC_RELATIONS   = YES
 INCLUDE_GRAPH          = YES
 INCLUDED_BY_GRAPH      = YES
 GRAPHICAL_HIERARCHY    = YES
-DOT_PATH               = 
-DOTFILE_DIRS           = 
-MAX_DOT_GRAPH_WIDTH    = 1024
-MAX_DOT_GRAPH_HEIGHT   = 1024
+DOT_PATH               =
+DOT_FONTNAME           = Arial
+DOTFILE_DIRS           =
 GENERATE_LEGEND        = YES
 DOT_CLEANUP            = YES
 #---------------------------------------------------------------------------
-# Configuration::addtions related to the search engine   
+# Configuration::additions related to the search engine
 #---------------------------------------------------------------------------
 SEARCHENGINE           = NO
-CGI_NAME               = search.cgi
-CGI_URL                = 
-DOC_URL                = 
-DOC_ABSPATH            = 
-BIN_ABSPATH            = /usr/local/bin/
-EXT_DOC_PATHS          =