Updated comments

Signed-off-by: Quincey Koziol <[email protected]>
qkoziol · Oct 10, 2024 · 6196482 · 6196482
1 parent 48e6373
commit 6196482
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/H5CXprivate.h b/src/H5CXprivate.h
@@ -272,8 +272,7 @@ typedef struct H5CX_t {
 /* Typedef for nodes on the API context stack */
 /* Each entry into the library through an API routine invokes H5CX_push()
  * in a FUNC_ENTER_API* macro, which pushes an H5CX_node_t on the API
- * context [thread-local] stack, after initializing it with default values
- * in H5CX__push_common().
+ * context [thread-local] stack, after initializing it with default values.
  */
 typedef struct H5CX_node_t {
     H5CX_t              ctx;  /* Context for current API call */

diff --git a/src/H5VL.c b/src/H5VL.c
@@ -771,7 +771,10 @@ H5VLretrieve_lib_state(void **state /*out*/)
 /*---------------------------------------------------------------------------
  * Function:    H5VLstart_lib_state
  *
- * Purpose:     Opens a new internal context for the HDF5 library.
+ * Purpose:     Opens a new internal context for the HDF5 library.  The context
+ *              returned (via the OUT parameter) must be passed to
+ *              H5VLfinish_lib_state to conclude the library's context and
+ *              release resources.
  *
  * Note:        This routine is _only_ for HDF5 VOL connector authors!  It is
  *              _not_ part of the public API for HDF5 application developers.