Salome HOME
Merge from V6_main 12/04/2013
[tools/medcoupling.git] / doc / doxygen / Doxyfile_med_user.in
index bbd06e6d3ff5848f970d03b36febb36099fb26ac..481c54269339a3444cdddb3161d6f03f9346a572 100644 (file)
@@ -1,31 +1,29 @@
-#  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+# Copyright (C) 2007-2013  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.
 #
-#  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
@@ -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
@@ -55,7 +54,7 @@ GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
 ALIASES                = 
-ENABLED_SECTIONS       = user MEDMEM_ug
+ENABLED_SECTIONS       = user MEDCOUPLING_ug
 MAX_INITIALIZER_LINES  = 30
 OPTIMIZE_OUTPUT_FOR_C  = NO
 SHOW_USED_FILES        = NO
@@ -70,25 +69,26 @@ WARN_LOGFILE           = log_user
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @srcdir@ \
+INPUT                  = @builddir@ \
+                        @srcdir@ \
+                        @srcdir@/fakesources \
                          @srcdir@/../../src/ParaMEDMEM \
                          @srcdir@/../../src/INTERP_KERNEL \
+                        @srcdir@/../../src/INTERP_KERNEL/Bases \
                          @srcdir@/../../src/INTERP_KERNEL/Geometric2D \
-                         @srcdir@/../../src/MEDMEM
+                         @srcdir@/../../src/MEDCoupling \
+                        @srcdir@/../../src/MEDLoader
 
-FILE_PATTERNS          = MEDMEM_Mesh.* \
-                         MEDMEM_Grid.* \
-                         MEDMEM_Meshing.* \
-                         MEDMEM_Support.* \
-                         MEDMEM_Field.* \
-                         MEDMEM_Med.* \
-                         IntersectionDEC.* \
+FILE_PATTERNS          = InterpKernelDEC.* \
+                        OverlapDEC.* \
                          DEC.* \
+                         DisjointDEC.* \
                          MPIProcessorGroup.* \
                          StructuredCoincidentDEC.* \
                          ExplicitCoincidentDEC.* \
                          NonCoincidentDEC.* \
                          CommInterface.* \
+                        NormalizedUnstructuredMesh.* \
                          Interpolation2D.* \
                          Interpolation3D.* \
                          Interpolation3DSurf.* \
@@ -96,22 +96,45 @@ 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.* \
+                         MEDCouplingUMeshDesc.* \
+                         MEDCouplingPointSet.* \
+                         MEDCouplingCMesh.* \
+                        MEDCouplingStructuredMesh.* \
+                        MEDCouplingCurveLinearMesh.* \
+                         MEDCouplingExtrudedMesh.* \
+                         MEDCouplingFieldDouble.* \
+                         MEDCouplingField.* \
+                        MEDCouplingNatureOfField.hxx \
+                        MEDCouplingFieldTemplate.* \
+                         MEDCouplingFieldDiscretization.* \
+                         MEDCouplingTimeDiscretization.* \
+                         MEDCouplingTimeLabel.* \
+                         MEDCouplingRefCountObject.* \
+                         MEDCouplingMemArray.* \
+                         MEDCouplingRemapper.* \
+                         MEDLoader.* \
+                         MEDFileMesh.* \
+                        MEDFileField.* \
                          *.dox
 RECURSIVE              = NO
 EXCLUDE                = CVS
 EXCLUDE_PATTERNS       = *~
-EXAMPLE_PATH           = @srcdir@/../../src/ParaMEDMEM/ \
-                         @srcdir@/../../doc/MEDMEM \
-                         @srcdir@/../../src/MEDMEM
+EXAMPLE_PATH           = @srcdir@/../../src/ParaMEDMEM \
+                        @srcdir@/../../src/MEDCoupling/Test \
+                        @srcdir@/../../src/MEDCoupling_Swig \
+                        @srcdir@/../../src/MEDLoader/Swig
 EXAMPLE_PATTERNS       = *.cxx *.py
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             = @srcdir@/figures
@@ -135,9 +158,9 @@ IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
-HTML_HEADER            = 
-HTML_FOOTER            = 
-HTML_STYLESHEET        = 
+HTML_HEADER            = @builddir@/static/header.html
+HTML_FOOTER            = @srcdir@/static/footer.html
+HTML_EXTRA_STYLESHEET  = @srcdir@/static/salome_extra.css
 HTML_ALIGN_MEMBERS     = YES
 GENERATE_HTMLHELP      = YES
 GENERATE_CHI           = YES
@@ -147,6 +170,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
 #---------------------------------------------------------------------------
@@ -183,13 +212,13 @@ GENERATE_XML           = NO
 # 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      = 
+EXPAND_AS_DEFINED      = MEDCOUPLING_EXPORT MEDCOUPLINGREMAPPER_EXPORT MEDLOADER_EXPORT
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 # Configuration::addtions related to external references   
@@ -211,6 +240,7 @@ INCLUDE_GRAPH          = YES
 INCLUDED_BY_GRAPH      = YES
 GRAPHICAL_HIERARCHY    = YES
 DOT_PATH               = 
+DOT_FONTNAME           = Arial
 DOTFILE_DIRS           = 
 MAX_DOT_GRAPH_WIDTH    = 1024
 MAX_DOT_GRAPH_HEIGHT   = 1024