From a1c81eda203addced514ef655f7a9079f3f0bb04 Mon Sep 17 00:00:00 2001
From: Scot Breitenfeld <brtnfld@hdfgroup.org>
Date: Wed, 14 Dec 2022 15:22:37 -0600
Subject: added doc. warning for H5Literate_async return value (#2295)

---
 src/H5Lpublic.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index 6f6c638..60e83f2 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -923,6 +923,11 @@ H5_DLL herr_t H5Literate2(hid_t grp_id, H5_index_t idx_type, H5_iter_order_t ord
 /**
  * --------------------------------------------------------------------------
  * \ingroup ASYNC
+ *
+ * \warning The returned value of the callback routine op will not be set
+ *          in the return value for H5Literate_async(), so the \p herr_t value
+ *          should not be used for determining the return state of the callback routine.
+ *
  * \async_variant_of{H5Literate}
  */
 #ifndef H5_DOXYGEN
-- 
cgit v0.12