Fix typos in property callback documentation (#4532)

HDFGroup · May 30, 2024 · acb9ca5 · acb9ca5
1 parent 162e7d6
commit acb9ca5
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 24 deletions.
diff --git a/src/H5Pfapl.c b/src/H5Pfapl.c
@@ -4976,7 +4976,9 @@ H5Pget_file_locking(hid_t fapl_id, hbool_t *use_file_locking /*out*/, hbool_t *i
 /*-------------------------------------------------------------------------
  * Function:       H5P__encode_coll_md_read_flag_t
  *
- * Purpose:        Generic encoding callback routine for 'coll_md_read_flag' properties.
+ * Purpose:        Callback routine which is called whenever the collective
+ *                 metadata read flag property in the file creation property list is
+ *                 encoded.
  *
  * Return:       Success:    Non-negative
  *           Failure:    Negative
@@ -5010,7 +5012,9 @@ H5P__encode_coll_md_read_flag_t(const void *value, void **_pp, size_t *size)
 /*-------------------------------------------------------------------------
  * Function:       H5P__decode_coll_md_read_flag_t
  *
- * Purpose:        Generic decoding callback routine for 'coll_md_read_flag' properties.
+ * Purpose:        Callback routine which is called whenever the collective
+ *                 metadata read flag property in the file creation property list is
+ *                 decoded.
  *
  * Return:       Success:    Non-negative
  *           Failure:    Negative
@@ -5030,7 +5034,7 @@ H5P__decode_coll_md_read_flag_t(const void **_pp, void *_value)
     assert(*pp);
     assert(coll_md_read_flag);
 
-    /* Decode file close degree */
+    /* Decode metadata read flag */
     *coll_md_read_flag = (H5P_coll_md_read_flag_t) * (*pp);
     *pp += sizeof(H5P_coll_md_read_flag_t);
 
@@ -5468,7 +5472,7 @@ H5P__facc_mpi_info_set(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATTR_UNUSED *
 /*-------------------------------------------------------------------------
  * Function:    H5P__facc_mpi_info_get
  *
- * Purpose:     Copies an MPI comminicator property when it's retrieved from a property list
+ * Purpose:     Copies an MPI info object property when it's retrieved from a property list
  *
  * Return:      Success:        Non-negative
  *              Failure:        Negative

diff --git a/src/H5Pfcpl.c b/src/H5Pfcpl.c
@@ -645,7 +645,7 @@ H5Pget_istore_k(hid_t plist_id, unsigned *ik /*out*/)
  * Function:       H5P__fcrt_btree_rank_enc
  *
  * Purpose:        Callback routine which is called whenever the index storage
- *                 btree in file creation property list is encoded.
+ *                 btree in a file creation property list is encoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -688,7 +688,7 @@ H5P__fcrt_btree_rank_enc(const void *value, void **_pp, size_t *size)
  * Function:       H5P__fcrt_btree_rank_dec
  *
  * Purpose:        Callback routine which is called whenever the index storage
- *                 btree in file creation property list is decoded.
+ *                 btree in a file creation property list is decoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -909,8 +909,8 @@ H5Pget_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned *mesg_type
  * Function:       H5P__fcrt_shmsg_index_types_enc
  *
  * Purpose:        Callback routine which is called whenever the shared
- *                 message indec types in file creation property list
- *                 is encoded.
+ *                 message index types in a file creation property list
+ *                 are encoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -953,8 +953,8 @@ H5P__fcrt_shmsg_index_types_enc(const void *value, void **_pp, size_t *size)
  * Function:       H5P__fcrt_shmsg_index_types_dec
  *
  * Purpose:        Callback routine which is called whenever the shared
- *                 message indec types in file creation property list
- *                 is decoded.
+ *                 message index types in a file creation property list
+ *                 are decoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -994,7 +994,7 @@ H5P__fcrt_shmsg_index_types_dec(const void **_pp, void *_value)
  * Function:       H5P__fcrt_shmsg_index_minsize_enc
  *
  * Purpose:        Callback routine which is called whenever the shared
- *                 message index minsize in file creation property list
+ *                 message index minsize in a file creation property list
  *                 is encoded.
  *
  * Return:	   Success:	Non-negative
@@ -1038,7 +1038,7 @@ H5P__fcrt_shmsg_index_minsize_enc(const void *value, void **_pp, size_t *size)
  * Function:       H5P__fcrt_shmsg_index_minsize_dec
  *
  * Purpose:        Callback routine which is called whenever the shared
- *                 message indec minsize in file creation property list
+ *                 message index minsize in a file creation property list
  *                 is decoded.
  *
  * Return:	   Success:	Non-negative

diff --git a/src/H5Pgcpl.c b/src/H5Pgcpl.c
@@ -485,7 +485,7 @@ H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_flags /*out*/)
  * Function:       H5P__gcrt_group_info_enc
  *
  * Purpose:        Callback routine which is called whenever the group
- *                 property in the dataset access property list is
+ *                 info property in the dataset access property list is
  *                 encoded.
  *
  * Return:	   Success:	Non-negative
@@ -564,7 +564,7 @@ H5P__gcrt_group_info_dec(const void **_pp, void *_value)
  * Function:       H5P__gcrt_link_info_enc
  *
  * Purpose:        Callback routine which is called whenever the link
- *                 property in the dataset access property list is
+ *                 info property in the dataset access property list is
  *                 encoded.
  *
  * Return:	   Success:	Non-negative

diff --git a/src/H5Plapl.c b/src/H5Plapl.c
@@ -634,7 +634,7 @@ H5P__lacc_elink_pref_get(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATTR_UNUSED
 /*-------------------------------------------------------------------------
  * Function:       H5P__lacc_elink_pref_enc
  *
- * Purpose:        Callback routine which is called whenever the elink flags
+ * Purpose:        Callback routine which is called whenever the elink prefix
  *                 property in the dataset access property list is
  *                 encoded.
  *

diff --git a/src/H5Pocpypl.c b/src/H5Pocpypl.c
@@ -179,7 +179,7 @@ H5P__ocpy_reg_prop(H5P_genclass_t *pclass)
 /*-------------------------------------------------------------------------
  * Function:    H5P__free_merge_comm_dtype_list
  *
- * Purpose:     Frees the provided merge named dtype list
+ * Purpose:     Frees the provided merge committed dtype list
  *
  * Return:      NULL
  *
@@ -329,9 +329,9 @@ H5P__ocpy_merge_comm_dt_list_get(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATT
 /*-------------------------------------------------------------------------
  * Function:       H5P__ocpy_merge_comm_dt_list_enc
  *
- * Purpose:        Callback routine which is called whenever the common
- *		   datatype property in the object copy property list is
- *                 decoded.
+ * Purpose:        Callback routine which is called whenever the merge
+ *                 committed datatype list property in the object copy
+ *                 property list is encoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -383,9 +383,9 @@ H5P__ocpy_merge_comm_dt_list_enc(const void *value, void **_pp, size_t *size)
 /*-------------------------------------------------------------------------
  * Function:       H5P__ocpy_merge_comm_dt_list_dec
  *
- * Purpose:        Callback routine which is called whenever the common
- *                 datatype property in the dataset access property list is
- *                 decoded.
+ * Purpose:        Callback routine which is called whenever the merge
+ *                 committed datatype list property in the object copy
+ *                 property list is decoded.
  *
  * Return:	   Success:	Non-negative
  *		   Failure:	Negative
@@ -564,7 +564,7 @@ H5P__ocpy_merge_comm_dt_list_cmp(const void *_dt_list1, const void *_dt_list2, s
 /*--------------------------------------------------------------------------
  * Function:	H5P__ocpy_merge_comm_dt_list_close
  *
- * Purpose:	Close the merge common datatype list property
+ * Purpose:	Close the merge committed datatype list property
  *
  * Return:	Success:	Non-negative
  * 		Failure:	Negative
@@ -578,7 +578,7 @@ H5P__ocpy_merge_comm_dt_list_close(const char H5_ATTR_UNUSED *name, size_t H5_AT
 
     assert(value);
 
-    /* Free the merge named dtype list */
+    /* Free the merge committed dtype list */
     H5P__free_merge_comm_dtype_list(*(H5O_copy_dtype_merge_list_t **)value);
 
     FUNC_LEAVE_NOAPI(SUCCEED)