summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2023-10-16 17:21:01 (GMT)
committerGitHub <noreply@github.com>2023-10-16 17:21:01 (GMT)
commit1b62827204d4fd924794c2bcb6456de70f6048b0 (patch)
tree3762b0445b4150cfbe0622101e73216e50a11c51 /src
parent85507981000e5d68788a3ff00f66adb1b0aca842 (diff)
downloadhdf5-1b62827204d4fd924794c2bcb6456de70f6048b0.zip
hdf5-1b62827204d4fd924794c2bcb6456de70f6048b0.tar.gz
hdf5-1b62827204d4fd924794c2bcb6456de70f6048b0.tar.bz2
Add Doxygen for H5Pset_fapl_sec2() (#3685)
*
Diffstat (limited to 'src')
-rw-r--r--src/H5FDsec2.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/H5FDsec2.h b/src/H5FDsec2.h
index 56f4575..a2590ae 100644
--- a/src/H5FDsec2.h
+++ b/src/H5FDsec2.h
@@ -23,7 +23,23 @@
extern "C" {
#endif
-H5_DLL hid_t H5FD_sec2_init(void);
+H5_DLL hid_t H5FD_sec2_init(void);
+
+/**
+ * \ingroup FAPL
+ *
+ * \brief Modifies the file access property list to use the #H5FD_SEC2 driver
+ *
+ * \fapl_id
+ *
+ * \returns \herr_t
+ *
+ * \details H5Pset_fapl_sec2() modifies the file access property list to use the
+ * #H5FD_SEC2 driver.
+ *
+ * \since 1.4.0
+ *
+ */
H5_DLL herr_t H5Pset_fapl_sec2(hid_t fapl_id);
#ifdef __cplusplus