summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDana Robinson <43805+derobins@users.noreply.github.com>2023-05-06 22:36:14 (GMT)
committerGitHub <noreply@github.com>2023-05-06 22:36:14 (GMT)
commit038216e2cf7a8533fa8eba7b024ed09e9a554991 (patch)
treebcff46c5de9010ce45ec12b16c58fa63ec84897e
parent6162b6f12e40a50937ac4a94661d81cf03a04c65 (diff)
downloadhdf5-038216e2cf7a8533fa8eba7b024ed09e9a554991.zip
hdf5-038216e2cf7a8533fa8eba7b024ed09e9a554991.tar.gz
hdf5-038216e2cf7a8533fa8eba7b024ed09e9a554991.tar.bz2
Add Doxygen for H5ES_NONE _WAIT_NONE/FOREVER (#2922)
-rw-r--r--src/H5ESpublic.h23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/H5ESpublic.h b/src/H5ESpublic.h
index f2c7cb5..b66ef21 100644
--- a/src/H5ESpublic.h
+++ b/src/H5ESpublic.h
@@ -18,23 +18,26 @@
#define H5ESpublic_H
/* Public headers needed by this file */
-#include "H5public.h" /* Generic Functions */
+#include "H5public.h"
/*****************/
/* Public Macros */
/*****************/
-/* Default value for "no event set" / synchronous execution */
-#define H5ES_NONE 0 /* (hid_t) */
+/**
+ * Default value for "no event set" / synchronous execution. Used in
+ * place of a @ref hid_t identifier.
+ */
+#define H5ES_NONE 0
/* Special "wait" timeout values */
-#define H5ES_WAIT_FOREVER (UINT64_MAX) /* Wait until all operations complete */
-#define H5ES_WAIT_NONE \
- (0) /* Don't wait for operations to complete, \
- * just check their status. \
- * (this allows H5ESwait to behave \
- * like a 'test' operation) \
- */
+#define H5ES_WAIT_FOREVER (UINT64_MAX) /**< Wait until all operations complete */
+
+/**
+ * Don't wait for operations to complete, just check their status.
+ * (This allows @ref H5ESwait to behave like a 'test' operation)
+ */
+#define H5ES_WAIT_NONE (0)
/*******************/
/* Public Typedefs */