From 3d0f8bab99bfb74d0f34c64d34462431e3bb7f5c Mon Sep 17 00:00:00 2001 From: Achim Gsell Date: Fri, 30 Jan 2009 15:03:27 +0000 Subject: [PATCH] - moved intro from C-source to H5.dox - add some new input-files to Doxydoc --- .gitattributes | 1 + doc/Doxyfile | 5 +++++ doc/H5.dox | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 doc/H5.dox diff --git a/.gitattributes b/.gitattributes index e1e7ba1..53af5cb 100644 --- a/.gitattributes +++ b/.gitattributes @@ -9,6 +9,7 @@ /autogen.sh -text /configure.ac -text doc/Doxyfile -text +doc/H5.dox -text doc/H5X_File_Format.txt -text doc/Makefile.am -text doc/doxyfooter -text diff --git a/doc/Doxyfile b/doc/Doxyfile index 6ca8526..62f07a8 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -82,8 +82,13 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- +INPUT += H5.dox +INPUT += ../src/h5_core/h5_attribs.c +INPUT += ../src/h5_core/h5_errorhandling.c +INPUT += ../src/H5.c INPUT += ../src/H5Part.c INPUT += ../src/H5Block.c +INPUT += ../src/H5Fed.c FILE_PATTERNS = RECURSIVE = YES EXCLUDE = diff --git a/doc/H5.dox b/doc/H5.dox new file mode 100644 index 0000000..eb2e8bb --- /dev/null +++ b/doc/H5.dox @@ -0,0 +1,50 @@ +/*! \mainpage H5Part: A Portable High Performance Parallel Data Interface to HDF5 + +Particle based simulations of accelerator beam-lines, especially in +six dimensional phase space, generate vast amounts of data. Even +though a subset of statistical information regarding phase space or +analysis needs to be preserved, reading and writing such enormous +restart files on massively parallel supercomputing systems remains +challenging. + +H5Part consists of Particles and Block structured Fields. + +Developed by: + + + +For further information contact: h5part + +Last modified on April 19, 2007. + +*/ + + +/*! + \defgroup h5_core H5 core functions +*/ + +/*! + \defgroup h5_c_api H5 C API +*/ + +/*! + \defgroup h5part_c_api H5Part C API +*/ + +/*! + \defgroup h5block_c_api H5Block C API +*/ + +/*! + \defgroup h5fed_c_api H5Fed C API +*/ +