summaryrefslogtreecommitdiffstats
path: root/src/H5Fpublic.h
diff options
context:
space:
mode:
authorGerd Heber <gheber@hdfgroup.org>2021-12-09 16:32:00 (GMT)
committerGitHub <noreply@github.com>2021-12-09 16:32:00 (GMT)
commitdab3838a635b9816940c4fa03b3185c37abab3e5 (patch)
treedca96b9d047b3b3d2b0eb2b8222e5883d2d66630 /src/H5Fpublic.h
parent2b4c2d9c7163274ad6008e701413edfd10f88b3b (diff)
downloadhdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.zip
hdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.tar.gz
hdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.tar.bz2
Fixed minor issues. (#1259)
* Fixed minor issues. * Committing clang-format changes * Fixed CMake. Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5Fpublic.h')
-rw-r--r--src/H5Fpublic.h30
1 files changed, 22 insertions, 8 deletions
diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h
index 806320b..c44e729 100644
--- a/src/H5Fpublic.h
+++ b/src/H5Fpublic.h
@@ -11,6 +11,28 @@
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+/**\defgroup H5F H5F
+ *
+ * Use the functions in this module to manage HDF5 files.
+ *
+ * In the code snippets below, we show the skeletal life cycle of an HDF5 file,
+ * when creating a new file (left) or when opening an existing file (right).
+ * File creation is essentially controlled through \ref FCPL, and file access to
+ * new and existing files is controlled through \ref FAPL. The file \c name and
+ * creation or access \c mode control the interaction with the underlying
+ * storage such as file systems.
+ *
+ * In addition to general file management functions, there are three categories
+ * of functions that deal with advanced file management tasks and use cases:
+ * 1. The control of the HDF5 \ref MDC
+ * 2. The use of (MPI-) \ref PH5F HDF5
+ *
+ * \defgroup MDC Metadata Cache
+ * \ingroup H5F
+ * \defgroup PH5F Parallel
+ * \ingroup H5F
+ */
+
/*
* This file contains public declarations for the H5F module.
*/
@@ -266,12 +288,6 @@ H5_DLL hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_
* \param[in] flags File access flags. Allowable values are:
* - #H5F_ACC_RDWR: Allows read and write access to file
* - #H5F_ACC_RDONLY: Allows read-only access to file
- * - #H5F_ACC_RDWR \c | #H5F_ACC_SWMR_WRITE: Indicates that
- * the file is open for writing in a
- * single-writer/multi-writer (SWMR) scenario.
- * - #H5F_ACC_RDONLY \c | #H5F_ACC_SWMR_READ: Indicates
- * that the file is open for reading in a
- * single-writer/multi-reader (SWMR) scenario.
* - An additional flag, #H5F_ACC_DEBUG, prints debug
* information. This flag can be combined with one of the
* above values using the bit-wise OR operator (\c |), but
@@ -344,8 +360,6 @@ H5_DLL hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_
* open call must include the file close degree setting
* #H5F_CLOSE_WEAK or the open will fail.
*
- * \version 1.10.0 The #H5F_ACC_SWMR_WRITE and #H5F_ACC_SWMR_READ flags were added.
- *
* \see H5Fclose()
*
*/