diff --git a/src/H5Apublic.h b/src/H5Apublic.h index 1d8ee66e1b2..7960efd546b 100644 --- a/src/H5Apublic.h +++ b/src/H5Apublic.h @@ -51,6 +51,9 @@ typedef struct { * \li Negative causes the iterator to immediately return that value, * indicating failure. The iterator can be restarted at the next * attribute. + * + * \since 1.8.0 + * */ typedef herr_t (*H5A_operator2_t)(hid_t location_id /*in*/, const char *attr_name /*in*/, const H5A_info_t *ainfo /*in*/, void *op_data /*in,out*/); diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h index d0900013796..19b9266556a 100644 --- a/src/H5Dpublic.h +++ b/src/H5Dpublic.h @@ -138,6 +138,8 @@ typedef enum H5D_vds_view_t { * * \return \herr_t * + * \since 1.10.0 + * */ typedef herr_t (*H5D_append_cb_t)(hid_t dataset_id, hsize_t *cur_dims, void *op_data); //! @@ -156,6 +158,8 @@ typedef herr_t (*H5D_append_cb_t)(hid_t dataset_id, hsize_t *cur_dims, void *op_ * the operation * \return \herr_t_iter * + * \since 1.10.2 + * */ typedef herr_t (*H5D_operator_t)(void *elem, hid_t type_id, unsigned ndim, const hsize_t *point, void *operator_data); @@ -186,6 +190,8 @@ typedef herr_t (*H5D_operator_t)(void *elem, hid_t type_id, unsigned ndim, const * been returned. The callback function should return zero (0) * to indicate success, and a negative value to indicate failure. * + * \since 1.10.2 + * */ typedef herr_t (*H5D_scatter_func_t)(const void **src_buf /*out*/, size_t *src_buf_bytes_used /*out*/, void *op_data); @@ -214,6 +220,8 @@ typedef herr_t (*H5D_scatter_func_t)(const void **src_buf /*out*/, size_t *src_b * function should return zero (0) to indicate success, and a negative * value to indicate failure. * + * \since 1.10.2 + * */ typedef herr_t (*H5D_gather_func_t)(const void *dst_buf, size_t dst_buf_bytes_used, void *op_data); //! @@ -234,6 +242,9 @@ typedef herr_t (*H5D_gather_func_t)(const void *dst_buf, size_t dst_buf_bytes_us * immediately return that value, indicating short-circuit success. * \li A negative (#H5_ITER_ERROR) causes the iterator to immediately * return that value, indicating failure. + * + * \since 1.14.0 + * */ typedef int (*H5D_chunk_iter_op_t)(const hsize_t *offset, unsigned filter_mask, haddr_t addr, hsize_t size, void *op_data); diff --git a/src/H5Epublic.h b/src/H5Epublic.h index 0d5993e84d4..2b0e48dc9fd 100644 --- a/src/H5Epublic.h +++ b/src/H5Epublic.h @@ -176,6 +176,9 @@ extern "C" { * \param[in] client_data Pointer to client data in the format expected by the * user-defined function * \return \herr_t + * + * \since 1.8.0 + * */ typedef herr_t (*H5E_walk2_t)(unsigned n, const H5E_error2_t *err_desc, void *client_data); //! @@ -188,6 +191,9 @@ typedef herr_t (*H5E_walk2_t)(unsigned n, const H5E_error2_t *err_desc, void *cl * \param[in] client_data Pointer to client data in the format expected by the * user-defined function * \return \herr_t + * + * \since 1.8.0 + * */ typedef herr_t (*H5E_auto2_t)(hid_t estack, void *client_data); //! diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index 094f3ff3427..db4f0c765b0 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -1955,10 +1955,8 @@ H5_DLL herr_t H5Fget_info1(hid_t obj_id, H5F_info1_t *file_info); * * \return \herr_t * - * \deprecated When? - * - * \todo In which version was this function introduced? - * \todo In which version was this function deprecated? + * \since 1.10.1 + * \deprecated 1.10.2 Deprecated in favor of the function H5Fset_libver_bounds() * */ H5_DLL herr_t H5Fset_latest_format(hid_t file_id, hbool_t latest_format); @@ -1971,12 +1969,10 @@ H5_DLL herr_t H5Fset_latest_format(hid_t file_id, hbool_t latest_format); * * \return \htri_t * - * \deprecated When? - * * \details H5Fis_hdf5() determines whether a file is in the HDF5 format. * - * \todo In which version was this function deprecated? - * \todo In which version was this function introduced? + * \since 1.0.0 + * \deprecated 1.12.0 Deprecated in favor of the function H5Fis_accessible() * */ H5_DLL htri_t H5Fis_hdf5(const char *file_name); diff --git a/src/H5Opublic.h b/src/H5Opublic.h index cee0660c5ce..23c4e4eb59b 100644 --- a/src/H5Opublic.h +++ b/src/H5Opublic.h @@ -189,6 +189,8 @@ typedef uint32_t H5O_msg_crt_idx_t; * pointer provided with the H5Ovisit3() function call * \return \herr_t_iter * + * \since 1.12.0 + * */ typedef herr_t (*H5O_iterate2_t)(hid_t obj, const char *name, const H5O_info2_t *info, void *op_data); //! @@ -1750,6 +1752,8 @@ typedef struct H5O_info1_t { * in processing the object * \return \herr_t_iter * + * \since 1.8.0 + * */ typedef herr_t (*H5O_iterate1_t)(hid_t obj, const char *name, const H5O_info1_t *info, void *op_data); //! diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 67425a9c02a..4c0d225e030 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -318,6 +318,9 @@ typedef herr_t (*H5P_cls_close_func_t)(hid_t prop_id, void *close_data); * * \details The H5P_prp_cb1_t() function describes the parameters used by the * property create, copy and close callback functions. + * + * \since 1.8.0 + * */ typedef herr_t (*H5P_prp_cb1_t)(const char *name, size_t size, void *value); //! @@ -334,6 +337,9 @@ typedef herr_t (*H5P_prp_cb1_t)(const char *name, size_t size, void *value); * * \details The H5P_prp_cb2_t() function describes the parameters used by the * property set, copy and delete callback functions. + * + * \since 1.8.0 + * */ typedef herr_t (*H5P_prp_cb2_t)(hid_t prop_id, const char *name, size_t size, void *value); //! @@ -383,6 +389,9 @@ typedef H5P_prp_cb1_t H5P_prp_copy_func_t; * \c value1 and \c value2 are equal. * * \see H5Pregister(), H5Pinsert() + * + * \since 1.8.0 + * */ typedef int (*H5P_prp_compare_func_t)(const void *value1, const void *value2, size_t size); //! diff --git a/src/H5Spublic.h b/src/H5Spublic.h index bf9e9118f64..a05b8c56437 100644 --- a/src/H5Spublic.h +++ b/src/H5Spublic.h @@ -541,6 +541,8 @@ H5_DLL hssize_t H5Sget_select_elem_npoints(hid_t spaceid); * \param[in] numpoints Number of element points to get * \param[out] buf List of element points selected * + * \return \herr_t + * * \details H5Sget_select_elem_pointlist() returns the list of element * points in the current dataspace selection \p space_id. Starting * with the \p startpoint in the list of points, \p numpoints diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h index ce578d5acee..83761af2f58 100644 --- a/src/H5Tpublic.h +++ b/src/H5Tpublic.h @@ -233,6 +233,7 @@ extern "C" { * \details If an exception like overflow happens during conversion, this * function is called if it's registered through H5Pset_type_conv_cb(). * + * \since 1.8.0 */ typedef H5T_conv_ret_t (*H5T_conv_except_func_t)(H5T_conv_except_t except_type, hid_t src_id, hid_t dst_id, void *src_buf, void *dst_buf, void *user_data);