summaryrefslogtreecommitdiffstats
path: root/src/H5VLmodule.h
diff options
context:
space:
mode:
authorScot Breitenfeld <brtnfld@hdfgroup.org>2022-10-25 17:41:38 (GMT)
committerGitHub <noreply@github.com>2022-10-25 17:41:38 (GMT)
commit7d1997ff7b545eed7077962fc379e6781c2ccc80 (patch)
treea5f03e607247584f04814f20a42e2cffa18a4016 /src/H5VLmodule.h
parent23e237e728e4961d0cb7cbea10d5f82a9731bf8c (diff)
downloadhdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.zip
hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.gz
hdf5-7d1997ff7b545eed7077962fc379e6781c2ccc80.tar.bz2
Removed the file, func, line args in the _async APIs fpr doxygen (#2179)
* Removed the: file, func, line args in the _async APIs from the doxygen arguments. Documented H5ESclean. * format fixes * fixed DOXYGEN_PREDEFINED * Fixed the #ifdet logic for doxygen, added missing multi-dataset va_args * format fixes * Use H5_DOXYGEN instead of H5_DOXYGEN_FORTRAN * reordered multidataset declarations * alt. for H5Aclose_async and H5Acreate_async * made doxgyen API into seperate blocks * updated codespell * Committing clang-format changes Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5VLmodule.h')
-rw-r--r--src/H5VLmodule.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h
index 495bdb7..d6e65db 100644
--- a/src/H5VLmodule.h
+++ b/src/H5VLmodule.h
@@ -636,7 +636,9 @@
* \todo Describe the VOL plugin life cycle.
*
* \defgroup ASYNC Asynchronous Functions
- * \brief Asynchronous Functions
+ * \brief List of the asynchronous functions.
+ * \note The argument \p es_id associated with the asynchronous APIs is the \Emph{event set id}. See H5ES for
+ *context.
*
* \defgroup H5VLDEF Definitions
* \ingroup H5VL