From 3110b2f943f782f49384dfe317041965606d4919 Mon Sep 17 00:00:00 2001 From: ageay Date: Fri, 8 Oct 2010 14:24:11 +0000 Subject: [PATCH] *** empty log message *** --- doc/doxygen/Doxyfile_med_user.in | 2 ++ doc/doxygen/main.dox | 2 ++ doc/doxygen/medloader.dox | 18 ++++++++++++++++++ 3 files changed, 22 insertions(+) create mode 100644 doc/doxygen/medloader.dox diff --git a/doc/doxygen/Doxyfile_med_user.in b/doc/doxygen/Doxyfile_med_user.in index 95bbc0d62..fe0058878 100644 --- a/doc/doxygen/Doxyfile_med_user.in +++ b/doc/doxygen/Doxyfile_med_user.in @@ -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 diff --git a/doc/doxygen/main.dox b/doc/doxygen/main.dox index 69d054975..d7e4c3893 100644 --- a/doc/doxygen/main.dox +++ b/doc/doxygen/main.dox @@ -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 index 000000000..3204abfb0 --- /dev/null +++ b/doc/doxygen/medloader.dox @@ -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. + +*/ -- 2.39.2