]> SALOME platform Git repositories - tools/medcoupling.git/commitdiff
Salome HOME
*** empty log message ***
authorageay <ageay>
Fri, 8 Oct 2010 14:24:11 +0000 (14:24 +0000)
committerageay <ageay>
Fri, 8 Oct 2010 14:24:11 +0000 (14:24 +0000)
doc/doxygen/Doxyfile_med_user.in
doc/doxygen/main.dox
doc/doxygen/medloader.dox [new file with mode: 0644]

index 95bbc0d62d4679b52e7f76bca5b9ebc9758c0f81..fe0058878ee2015db4db0664f36831a0a1979426 100644 (file)
@@ -73,6 +73,7 @@ INPUT                  = @srcdir@ \
                          @srcdir@/../../src/INTERP_KERNEL \
                          @srcdir@/../../src/INTERP_KERNEL/Geometric2D \
                          @srcdir@/../../src/MEDCoupling \
+                        @srcdir@/../../src/MEDLoader \
                          @srcdir@/../../src/MEDMEM
 
 FILE_PATTERNS          = MEDMEM_Mesh.* \
@@ -113,6 +114,7 @@ FILE_PATTERNS          = MEDMEM_Mesh.* \
                         MEDCouplingFieldDouble.* \
                         MEDCouplingFieldDiscretization.* \
                         MEDCouplingTimeDiscretization.* \
+                        MEDLoader.* \
                          *.dox
 RECURSIVE              = NO
 EXCLUDE                = CVS
index 69d054975e31bff9de614741856afe7b3826e778..d7e4c38939ef1b4a1261f0cdc235b7c22c336305 100644 (file)
@@ -19,6 +19,8 @@ localization library.
 - Chapter \ref medcoupling describes DataStructures used for cross
 process exchange of meshes and fields.
 - Chapter \ref paramedmem describes its MPI implementation, which is called %ParaMEDMEM.
+- Chapter \ref medloader describes API for I/O from or to a MED file
+coming from a \ref medcoupling data structure.
 - Chapter \ref tools describes various tools based on MEDMEM  that can
 be helpful for handling MED files (conversion tools and splitting tools). 
 
diff --git a/doc/doxygen/medloader.dox b/doc/doxygen/medloader.dox
new file mode 100644 (file)
index 0000000..3204abf
--- /dev/null
@@ -0,0 +1,18 @@
+/*!
+\page medloader MEDLoader
+
+\section MEDLoaderIntro Introduction
+
+MEDLoader is a package in charge of loading a file or write to a file
+in MED format a \ref medcoupling data structure. The fact that these
+functionalities are not merged in \ref medcoupling is explained by the
+fact of reducing as much as possible the dependancies of \ref
+medcoupling libraries.
+
+The main aim of this package is to propose as much as possible a
+complete API in order to fetch data from a MED file. As a MED file can
+combine several \ref medcoupling aspects in one (for exemple
+unstructured meshes) the API of MEDLoader is much more rich than
+simply read and write.
+
+*/