From 37124bc1c1d3cd2114433a6d71648fcd57fd2bcf Mon Sep 17 00:00:00 2001 From: Gerd Heber Date: Thu, 21 Dec 2023 14:51:58 -0600 Subject: Doc versions (#3903) * Added missing \since tags to H5D. * Committing clang-format changes * Fixed H5T version info. * Committing clang-format changes * Added missing version info to H5E. * Committing clang-format changes * Added version info to H5F public APIs. * Committing clang-format changes * Added missing H5Z public API version info. * Added missing version info to H5G public APIs * Added missing version info to H5I public API. * Added missing version info to H5 public APIs * Committing clang-format changes * Added missing version info to H5P public APIs * Added missing version info to H5R public APIs * Fix comment error. * Committing clang-format changes --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> --- src/H5Dpublic.h | 17 ++++++++- src/H5Epublic.h | 20 +++++++++++ src/H5Fpublic.h | 40 +++++++++++++++++++++ src/H5Gpublic.h | 39 +++++++++++++++++++- src/H5Idevelop.h | 2 ++ src/H5Ipublic.h | 30 ++++++++++++++-- src/H5Ppublic.h | 48 +++++++++++++++++++------ src/H5Rpublic.h | 45 +++++++++++++++++++++-- src/H5Tpublic.h | 106 +++++++++++++++++++++++++++++++++++-------------------- src/H5Zdevelop.h | 5 +++ src/H5Zpublic.h | 2 +- src/H5public.h | 21 ++++++++++- 12 files changed, 315 insertions(+), 60 deletions(-) diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h index a4c60cd..35d0edf 100644 --- a/src/H5Dpublic.h +++ b/src/H5Dpublic.h @@ -424,6 +424,8 @@ H5_DLL hid_t H5Dopen_async(hid_t loc_id, const char *name, hid_t dapl_id, hid_t * be released with H5Sclose() when the identifier is no longer * needed so that resource leaks will not occur. * + * \since 1.0.0 + * * \par Example * \snippet H5D_examples.c update * @@ -494,6 +496,8 @@ H5_DLL herr_t H5Dget_space_status(hid_t dset_id, H5D_space_status_t *allocation) * opened datatype is returned. Otherwise, the returned datatype * is read-only. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Dget_type(hid_t dset_id); @@ -515,6 +519,8 @@ H5_DLL hid_t H5Dget_type(hid_t dset_id); * The creation property list identifier should be released with * H5Pclose() to prevent resource leaks. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Dget_create_plist(hid_t dset_id); @@ -590,6 +596,7 @@ H5_DLL hid_t H5Dget_access_plist(hid_t dset_id); * with no stored values, and 0 (zero), the value returned to * indicate an error. * + * \since 1.2.0 * */ H5_DLL hsize_t H5Dget_storage_size(hid_t dset_id); @@ -872,6 +879,8 @@ H5_DLL haddr_t H5Dget_offset(hid_t dset_id); * \par Example * \snippet H5D_examples.c read * + * \since 1.0.0 + * */ H5_DLL herr_t H5Dread(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, void *buf /*out*/); @@ -1060,6 +1069,8 @@ H5_DLL herr_t H5Dread_multi_async(size_t count, hid_t dset_id[], hid_t mem_type_ * \par Example * \snippet H5D_examples.c update * + * \since 1.0.0 + * * \see H5Pset_fill_time(), H5Pset_alloc_time() * */ @@ -1355,6 +1366,7 @@ H5_DLL herr_t H5Dvlen_get_buf_size(hid_t dset_id, hid_t type_id, hid_t space_id, * * \see H5Pset_fill_value(), H5Pget_fill_value(), H5Pfill_value_defined(), * H5Pset_fill_time(), H5Pget_fill_time(), H5Pcreate(), H5Dcreate_anon() + * \since 1.6.0 * */ H5_DLL herr_t H5Dfill(const void *fill, hid_t fill_type_id, void *buf, hid_t buf_type_id, hid_t space_id); @@ -1598,7 +1610,7 @@ H5_DLL herr_t H5Dgather(hid_t src_space_id, const void *src_buf, hid_t type_id, * \par Example * \snippet H5D_examples.c read * - * \since 1.8.0 + * \since 1.0.0 * * \see H5Dcreate2(), H5Dopen2() * @@ -1811,6 +1823,7 @@ H5_DLL hid_t H5Dopen1(hid_t loc_id, const char *name); * * \version 1.8.0 Function deprecated in this release. Parameter size * syntax changed to \Code{const hsize_t size[]} in this release. + * \since 1.0.0 * */ H5_DLL herr_t H5Dextend(hid_t dset_id, const hsize_t size[]); @@ -1847,6 +1860,8 @@ H5_DLL herr_t H5Dextend(hid_t dset_id, const hsize_t size[]); * * \version 1.12.0 Function was deprecated * + * \since 1.2.0 + * */ H5_DLL herr_t H5Dvlen_reclaim(hid_t type_id, hid_t space_id, hid_t dxpl_id, void *buf); diff --git a/src/H5Epublic.h b/src/H5Epublic.h index b6cc1cb..a22c9c6 100644 --- a/src/H5Epublic.h +++ b/src/H5Epublic.h @@ -697,6 +697,9 @@ typedef struct H5E_error1_t { * \param[in] client_data Pointer to client data in the format expected by the * user-defined function * \return \herr_t + * + * \since 1.0.0 + * */ typedef herr_t (*H5E_walk1_t)(int n, H5E_error1_t *err_desc, void *client_data); //! @@ -708,6 +711,9 @@ typedef herr_t (*H5E_walk1_t)(int n, H5E_error1_t *err_desc, void *client_data); * \param[in] client_data Pointer to client data in the format expected by the * user-defined function * \return \herr_t + * + * \since 1.0.0 + * */ typedef herr_t (*H5E_auto1_t)(void *client_data); //! @@ -728,6 +734,8 @@ typedef herr_t (*H5E_auto1_t)(void *client_data); * The stack is also cleared whenever an API function is called, with * certain exceptions (for instance, H5Eprint1()). * + * \since 1.0.0 + * */ H5_DLL herr_t H5Eclear1(void); /** @@ -772,6 +780,8 @@ H5_DLL herr_t H5Eclear1(void); * H5Eprint2(), mixing H5Eset_auto1() and H5Eget_auto2() or mixing * H5Eset_auto2() and H5Eget_auto1() does not fail. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Eget_auto1(H5E_auto1_t *func, void **client_data); /** @@ -826,6 +836,8 @@ H5_DLL herr_t H5Epush1(const char *file, const char *func, unsigned line, H5E_ma * that prints error messages. Users are encouraged to write their own * more specific error handlers. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Eprint1(FILE *stream); /** @@ -857,6 +869,8 @@ H5_DLL herr_t H5Eprint1(FILE *stream); * Automatic stack traversal is always in the #H5E_WALK_DOWNWARD * direction. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Eset_auto1(H5E_auto1_t func, void *client_data); /** @@ -890,6 +904,8 @@ H5_DLL herr_t H5Eset_auto1(H5E_auto1_t func, void *client_data); * is as follows: * \snippet this H5E_walk1_t_snip * + * \since 1.0.0 + * */ H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client_data); /** @@ -911,6 +927,8 @@ H5_DLL herr_t H5Ewalk1(H5E_direction_t direction, H5E_walk1_t func, void *client * array). An application calling this function must free the memory * associated with the return value to prevent a memory leak. * + * \since 1.0.0 + * */ H5_DLL char *H5Eget_major(H5E_major_t maj); /** @@ -934,6 +952,8 @@ H5_DLL char *H5Eget_major(H5E_major_t maj); * the memory associated with the return value to prevent a memory * leak. This is a change from the 1.6.x release series. * + * \since 1.0.0 + * */ H5_DLL char *H5Eget_minor(H5E_minor_t min); #endif /* H5_NO_DEPRECATED_SYMBOLS */ diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index 34a92ac..adb272e 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -355,6 +355,9 @@ H5_DLL hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_ * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Fcreate} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Fcreate_async(const char *app_file, const char *app_func, unsigned app_line, @@ -451,14 +454,20 @@ H5_DLL hid_t H5Fcreate_async(const char *filename, unsigned flags, hid_t fcpl_id * * \version 1.10.0 The #H5F_ACC_SWMR_WRITE and #H5F_ACC_SWMR_READ flags were added. * + * \since 1.0.0 + * * \see H5Fclose() * + * */ H5_DLL hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id); /** * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Fopen} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Fopen_async(const char *app_file, const char *app_func, unsigned app_line, @@ -490,12 +499,17 @@ H5_DLL hid_t H5Fopen_async(const char *filename, unsigned flags, hid_t access_pl * active \p file_id. E.g., one cannot close a file with H5Fclose() on * \p file_id then use H5Freopen() on \p file_id to reopen it. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Freopen(hid_t file_id); /** * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Freopen} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Freopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t file_id, @@ -534,12 +548,17 @@ H5_DLL hid_t H5Freopen_async(hid_t file_id, hid_t es_id); * that, the OS is responsible for ensuring that the data is * actually flushed to disk. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Fflush(hid_t object_id, H5F_scope_t scope); /** * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Fflush} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Fflush_async(const char *app_file, const char *app_func, unsigned app_line, hid_t object_id, @@ -587,6 +606,8 @@ H5_DLL herr_t H5Fflush_async(hid_t object_id, H5F_scope_t scope, hid_t es_id); * before calling H5Fclose. It is generally recommended to do so in all * cases. * + * \since 1.0.0 + * * \see H5Fopen() * */ @@ -595,6 +616,9 @@ H5_DLL herr_t H5Fclose(hid_t file_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Fclose} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Fclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t file_id, @@ -657,6 +681,8 @@ H5_DLL herr_t H5Fdelete(const char *filename, hid_t fapl_id); * The creation property list identifier should be released with * H5Pclose(). * + * \since 1.0.0 + * */ H5_DLL hid_t H5Fget_create_plist(hid_t file_id); /** @@ -670,6 +696,8 @@ H5_DLL hid_t H5Fget_create_plist(hid_t file_id); * \details H5Fget_access_plist() returns the file access property list * identifier of the specified file. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Fget_access_plist(hid_t file_id); /** @@ -750,6 +778,8 @@ H5_DLL herr_t H5Fget_fileno(hid_t file_id, unsigned long *fileno); * of objects to be counted. #H5F_OBJ_LOCAL restricts the * search to objects opened through current file identifier. * + * \since 1.6.0 + * */ H5_DLL ssize_t H5Fget_obj_count(hid_t file_id, unsigned types); /** @@ -843,6 +873,8 @@ H5_DLL herr_t H5Fget_vfd_handle(hid_t file_id, hid_t fapl, void **file_handle); * proper value to pass for \p plist is #H5P_DEFAULT, indicating the * default file mount property list. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Fmount(hid_t loc, const char *name, hid_t child, hid_t plist); /** @@ -865,6 +897,8 @@ H5_DLL herr_t H5Fmount(hid_t loc, const char *name, hid_t child, hid_t plist); * parent; if it was opened after the mount then it is the root group * of the child. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Funmount(hid_t loc, const char *name); /** @@ -1068,6 +1102,8 @@ H5_DLL herr_t H5Fset_mdc_config(hid_t file_id, const H5AC_cache_config_t *config * See the overview of the metadata cache in the special topics section of the user manual for * details on the metadata cache and its adaptive resize algorithms. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Fget_mdc_hit_rate(hid_t file_id, double *hit_rate_ptr); /** @@ -1099,6 +1135,8 @@ H5_DLL herr_t H5Fget_mdc_hit_rate(hid_t file_id, double *hit_rate_ptr); * Current size can exceed maximum size under certain conditions. See the overview of the * metadata cache in the special topics section of the user manual for a discussion of this. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Fget_mdc_size(hid_t file_id, size_t *max_size_ptr, size_t *min_clean_size_ptr, size_t *cur_size_ptr, int *cur_num_entries_ptr); @@ -1128,6 +1166,8 @@ H5_DLL herr_t H5Fget_mdc_size(hid_t file_id, size_t *max_size_ptr, size_t *min_c * you should not be using this API call. * \endparblock * + * \since 1.8.0 + * */ H5_DLL herr_t H5Freset_mdc_hit_rate_stats(hid_t file_id); /** diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h index cc04680..4c0e2de 100644 --- a/src/H5Gpublic.h +++ b/src/H5Gpublic.h @@ -214,6 +214,9 @@ H5_DLL hid_t H5Gopen2(hid_t loc_id, const char *name, hid_t gapl_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Gopen} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Gopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, @@ -273,6 +276,9 @@ H5_DLL herr_t H5Gget_info(hid_t loc_id, H5G_info_t *ginfo); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Gget_info} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Gget_info_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, @@ -317,6 +323,9 @@ H5_DLL herr_t H5Gget_info_by_name(hid_t loc_id, const char *name, H5G_info_t *gi * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Gget_info_by_name} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Gget_info_by_name_async(const char *app_file, const char *app_func, unsigned app_line, @@ -377,6 +386,9 @@ H5_DLL herr_t H5Gget_info_by_idx(hid_t loc_id, const char *group_name, H5_index_ * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Gget_info_by_idx} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Gget_info_by_idx_async(const char *app_file, const char *app_func, unsigned app_line, @@ -468,6 +480,9 @@ H5_DLL herr_t H5Gclose(hid_t group_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Gclose} + * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Gclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t group_id, @@ -683,6 +698,8 @@ H5_DLL hid_t H5Gopen1(hid_t loc_id, const char *name); * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Glink(hid_t cur_loc_id, H5G_link_t type, const char *cur_name, const char *new_name); /** @@ -716,9 +733,11 @@ H5_DLL herr_t H5Glink(hid_t cur_loc_id, H5G_link_t type, const char *cur_name, c * current_name is \Code{./foo}, \p new_name is \Code{./x/y/bar}, and a * request is made for \Code{./x/y/bar}, then the actual object looked * up is \Code{./x/y/./foo}. - + * * \version 1.8.0 Function deprecated in this release. * + * \since 1.6.0 + * */ H5_DLL herr_t H5Glink2(hid_t cur_loc_id, const char *cur_name, H5G_link_t type, hid_t new_loc_id, const char *new_name); @@ -748,6 +767,8 @@ H5_DLL herr_t H5Glink2(hid_t cur_loc_id, const char *cur_name, H5G_link_t type, * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Gmove(hid_t src_loc_id, const char *src_name, const char *dst_name); /** @@ -779,6 +800,8 @@ H5_DLL herr_t H5Gmove(hid_t src_loc_id, const char *src_name, const char *dst_na * * \version 1.8.0 Function deprecated in this release. * + * \since 1.6.0 + * */ H5_DLL herr_t H5Gmove2(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name); /** @@ -820,6 +843,8 @@ H5_DLL herr_t H5Gmove2(hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Gunlink(hid_t loc_id, const char *name); /** @@ -858,6 +883,8 @@ H5_DLL herr_t H5Gunlink(hid_t loc_id, const char *name); * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Gget_linkval(hid_t loc_id, const char *name, size_t size, char *buf /*out*/); /** @@ -898,6 +925,8 @@ H5_DLL herr_t H5Gget_linkval(hid_t loc_id, const char *name, size_t size, char * * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name, const char *comment); /** @@ -943,6 +972,8 @@ H5_DLL herr_t H5Gset_comment(hid_t loc_id, const char *name, const char *comment * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL int H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize, char *buf); /** @@ -1008,6 +1039,8 @@ H5_DLL int H5Gget_comment(hid_t loc_id, const char *name, size_t bufsize, char * * * \version 1.8.0 Function deprecated in this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Giterate(hid_t loc_id, const char *name, int *idx, H5G_iterate_t op, void *op_data); /** @@ -1029,6 +1062,8 @@ H5_DLL herr_t H5Giterate(hid_t loc_id, const char *name, int *idx, H5G_iterate_t * * \version 1.8.0 Function deprecated in this release. * + * \since 1.6.0 + * */ H5_DLL herr_t H5Gget_num_objs(hid_t loc_id, hsize_t *num_objs); /** @@ -1086,6 +1121,8 @@ H5_DLL herr_t H5Gget_num_objs(hid_t loc_id, hsize_t *num_objs); * \version 1.6.1 Two new fields were added to the \ref H5G_stat_t struct in * this release. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf /*out*/); diff --git a/src/H5Idevelop.h b/src/H5Idevelop.h index d0ff200..2eaa61a 100644 --- a/src/H5Idevelop.h +++ b/src/H5Idevelop.h @@ -128,6 +128,8 @@ extern "C" { * \note The H5Iregister_future() function is primarily targeted at VOL connector * authors and is _not_ designed for general-purpose application use. * + * \since 1.14.0 + * */ H5_DLL hid_t H5Iregister_future(H5I_type_t type, const void *object, H5I_future_realize_func_t realize_cb, H5I_future_discard_func_t discard_cb); diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h index ce78ae3..3e429ec 100644 --- a/src/H5Ipublic.h +++ b/src/H5Ipublic.h @@ -125,6 +125,8 @@ extern "C" { * will be a reference to. This pointer will be stored by the library * and returned via a call to H5Iobject_verify(). * + * \since 1.8.0 + * */ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); /** @@ -148,6 +150,8 @@ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); * * \see H5Iregister() * + * \since 1.8.0 + * */ H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type); /** @@ -178,6 +182,8 @@ H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type); * The pointer returned by H5Iregister() must be deallocated by the user * to avoid memory leaks. * + * \since 1.8.0 + * */ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type); /** @@ -202,6 +208,8 @@ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type); * is valid identifier. Validity can be determined with a call to * H5Iis_valid(). * + * \since 1.0.0 + * */ H5_DLL H5I_type_t H5Iget_type(hid_t id); /** @@ -311,7 +319,7 @@ H5_DLL ssize_t H5Iget_name(hid_t id, char *name /*out*/, size_t size); * safely closed or decremented and the HDF5 object will be closed * when the reference count for that that object drops to zero. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Iinc_ref(hid_t id); @@ -357,7 +365,7 @@ H5_DLL int H5Iinc_ref(hid_t id); * safely closed or decremented and the HDF5 object will be closed * when the reference count for that object drops to zero. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Idec_ref(hid_t id); @@ -381,7 +389,7 @@ H5_DLL int H5Idec_ref(hid_t id); * The function H5Iis_valid() is used to determine whether a specific * object identifier is valid. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Iget_ref(hid_t id); @@ -415,6 +423,8 @@ H5_DLL int H5Iget_ref(hid_t id); * pointer which was passed in to the H5Iregister() function. The \p * free_func function should return 0 on success and -1 on failure. * + * \since 1.8.0 + * */ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func); /** @@ -439,6 +449,8 @@ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free * identifiers will be entirely unchanged. If the force flag is true, * all identifiers of this type will be deleted. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); /** @@ -462,6 +474,8 @@ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); * reused when new types are registered, it is a good idea to set the * variable holding the value of the destroyed type to #H5I_UNINIT. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); /** @@ -481,6 +495,8 @@ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); * reference count is to be incremented. This identifier must have * been created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Iinc_type_ref(H5I_type_t type); /** @@ -501,6 +517,8 @@ H5_DLL int H5Iinc_type_ref(H5I_type_t type); * reference count is to be decremented. This identifier must have * been created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Idec_type_ref(H5I_type_t type); /** @@ -520,6 +538,8 @@ H5_DLL int H5Idec_type_ref(H5I_type_t type); * reference count is to be retrieved. This identifier must have been * created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Iget_type_ref(H5I_type_t type); /** @@ -561,6 +581,8 @@ H5_DLL int H5Iget_type_ref(H5I_type_t type); * The \p key parameter will be passed to the search function as a * parameter. It can be used to further define the search at run-time. * + * \since 1.8.0 + * */ H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key); /** @@ -613,6 +635,8 @@ H5_DLL herr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void *op_data); * exist, or it has been destroyed, \p num_members is returned with * the value 0. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Inmembers(H5I_type_t type, hsize_t *num_members); /** diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 3a05910..c6a780f 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -3370,7 +3370,7 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz * file driver remains registered. * * - * \since 1.4.0 + * \since 1.2.0 * */ H5_DLL hid_t H5Pget_driver(hid_t plist_id); @@ -3410,6 +3410,8 @@ H5_DLL hid_t H5Pget_driver(hid_t plist_id); * described this function only in the virtual file driver * documentation. * + * \since 1.4.0 + * */ H5_DLL const void *H5Pget_driver_info(hid_t plist_id); /** @@ -3436,7 +3438,7 @@ H5_DLL const void *H5Pget_driver_info(hid_t plist_id); * string is simply returned. The caller can then allocate a buffer * of the appropriate size and call this routine again. * - * \version 1.14.0 Function publicized in this release. + * \since 1.14.0 * */ H5_DLL ssize_t H5Pget_driver_config_str(hid_t fapl_id, char *config_buf, size_t buf_size); @@ -4274,6 +4276,8 @@ H5_DLL herr_t H5Pset_core_write_tracking(hid_t fapl_id, hbool_t is_enabled, size * described this function only in the virtual file driver * documentation. * + * \since 1.4.0 + * */ H5_DLL herr_t H5Pset_driver(hid_t plist_id, hid_t driver_id, const void *driver_info); /** @@ -4297,7 +4301,7 @@ H5_DLL herr_t H5Pset_driver(hid_t plist_id, hid_t driver_id, const void *driver_ * registered, an attempt will be made to load the driver as a * plugin. * - * \version 1.14.0 Function publicized in this release. + * \since 1.14.0 * */ H5_DLL herr_t H5Pset_driver_by_name(hid_t plist_id, const char *driver_name, const char *driver_config); @@ -4322,7 +4326,7 @@ H5_DLL herr_t H5Pset_driver_by_name(hid_t plist_id, const char *driver_name, con * registered, an attempt will be made to load the driver as a * plugin. * - * \version 1.14.0 Function publicized in this release. + * \since 1.14.0 * */ H5_DLL herr_t H5Pset_driver_by_value(hid_t plist_id, H5FD_class_value_t driver_value, @@ -4796,6 +4800,8 @@ H5_DLL herr_t H5Pset_file_locking(hid_t fapl_id, hbool_t use_file_locking, hbool * * The default value for garbage collecting references is off. * + * \since 1.2.0 + * */ H5_DLL herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref); /** @@ -5669,8 +5675,7 @@ H5_DLL herr_t H5Pget_coll_metadata_write(hid_t plist_id, hbool_t *is_collective) * \details H5Pget_mpi_params() gets the MPI communicator and info stored in * the file access property list \p fapl_id. * - * \todo When was this introduced? - * + * \since 1.12.0 */ H5_DLL herr_t H5Pget_mpi_params(hid_t fapl_id, MPI_Comm *comm, MPI_Info *info); @@ -5687,7 +5692,7 @@ H5_DLL herr_t H5Pget_mpi_params(hid_t fapl_id, MPI_Comm *comm, MPI_Info *info); * \details H5Pset_mpi_params() sets the MPI communicator and info stored in * the file access property list \p fapl_id. * - * \todo When was this introduced? + * \since 1.12.0 * */ H5_DLL herr_t H5Pset_mpi_params(hid_t fapl_id, MPI_Comm comm, MPI_Info info); @@ -7231,7 +7236,7 @@ H5_DLL herr_t H5Pget_chunk_cache(hid_t dapl_id, size_t *rdcc_nslots /*out*/, siz * file location behavior and for notes on the use of the * HDF5_EXTFILE_PREFIX environment variable. * - * \since 1.10.0, 1.8.17 + * \since 1.8.17 * */ H5_DLL ssize_t H5Pget_efile_prefix(hid_t dapl_id, char *prefix /*out*/, size_t size); @@ -7576,7 +7581,7 @@ H5_DLL herr_t H5Pset_chunk_cache(hid_t dapl_id, size_t rdcc_nslots, size_t rdcc_ * \note On Windows, the prefix must be an ASCII string since the Windows * standard C library's I/O functions cannot handle UTF-8 file names. * - * \since 1.10.0, 1.8.17 + * \since 1.8.17 * */ H5_DLL herr_t H5Pset_efile_prefix(hid_t dapl_id, const char *prefix); @@ -7703,6 +7708,8 @@ H5_DLL herr_t H5Pset_virtual_view(hid_t dapl_id, H5D_vds_view_t view); * \p left, \p middle, and \p right, as set by the H5Pset_btree_ratios() * function. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Pget_btree_ratios(hid_t plist_id, double *left /*out*/, double *middle /*out*/, double *right /*out*/); @@ -7725,6 +7732,8 @@ H5_DLL herr_t H5Pget_btree_ratios(hid_t plist_id, double *left /*out*/, double * * \version 1.6.0 The return type changed from \p hsize_t to \p size_t. * \version 1.4.0 The return type changed to \p hsize_t. * + * \since 1.0.0 + * */ H5_DLL size_t H5Pget_buffer(hid_t plist_id, void **tconv /*out*/, void **bkg /*out*/); /** @@ -7915,6 +7924,8 @@ H5_DLL herr_t H5Pget_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t *alloc_fun * * All ratios are real numbers between 0 and 1, inclusive. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Pset_btree_ratios(hid_t plist_id, double left, double middle, double right); @@ -7956,6 +7967,8 @@ H5_DLL herr_t H5Pset_btree_ratios(hid_t plist_id, double left, double middle, do * \version 1.6.0 The \p size parameter has changed from type hsize_t to \c size_t. * \version 1.4.0 The \p size parameter has changed to type hsize_t. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, void *bkg); @@ -8667,7 +8680,7 @@ H5_DLL herr_t H5Pget_create_intermediate_group(hid_t plist_id, unsigned *crt_int * * \details H5Pset_create_intermediate_group() * - * \since + * \since 1.8.0 * */ H5_DLL herr_t H5Pset_create_intermediate_group(hid_t plist_id, unsigned crt_intmd); @@ -10007,6 +10020,8 @@ H5_DLL herr_t H5Pset_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t func, v * The #H5P_prp_cb2_t is as follows: * \snippet this H5P_prp_cb2_t_snip * + * \since 1.4.0 + * */ /* Function prototypes */ @@ -10121,6 +10136,8 @@ H5_DLL herr_t H5Pregister1(hid_t cls_id, const char *name, size_t size, void *de * The #H5P_prp_cb2_t is as follows: * \snippet this H5P_prp_cb2_t_snip * + * \since 1.4.0 + * */ H5_DLL herr_t H5Pinsert1(hid_t plist_id, const char *name, size_t size, void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, @@ -10220,6 +10237,8 @@ H5_DLL herr_t H5Pencode1(hid_t plist_id, void *buf, size_t *nalloc); * deprecated in this release. * \version 1.6.4 \p filter parameter type changed to unsigned. * + * \since 1.0.0 + * */ H5_DLL H5Z_filter_t H5Pget_filter1(hid_t plist_id, unsigned filter, unsigned int *flags /*out*/, size_t *cd_nelmts /*out*/, unsigned cd_values[] /*out*/, size_t namelen, @@ -10274,7 +10293,9 @@ H5_DLL H5Z_filter_t H5Pget_filter1(hid_t plist_id, unsigned filter, unsigned int * lists. * \version 1.8.0 Function H5Pget_filter_by_id() renamed to * H5Pget_filter_by_id1() and deprecated in this release. - * \version 1.6.0 Function introduced in this release. + * + * \since 1.6.0 + * */ H5_DLL herr_t H5Pget_filter_by_id1(hid_t plist_id, H5Z_filter_t id, unsigned int *flags /*out*/, size_t *cd_nelmts /*out*/, unsigned cd_values[] /*out*/, size_t namelen, @@ -10303,6 +10324,8 @@ H5_DLL herr_t H5Pget_filter_by_id1(hid_t plist_id, H5Z_filter_t id, unsigned int * \version 1.6.4 \p boot, \p freelist, \p stab, \p shhdr parameter types * changed to unsigned. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Pget_version(hid_t plist_id, unsigned *boot /*out*/, unsigned *freelist /*out*/, unsigned *stab /*out*/, unsigned *shhdr /*out*/); @@ -10324,6 +10347,8 @@ H5_DLL herr_t H5Pget_version(hid_t plist_id, unsigned *boot /*out*/, unsigned *f * * \details Maps to the function H5Pset_file_space_strategy(). * + * \since 1.10.0 + * */ H5_DLL herr_t H5Pset_file_space(hid_t plist_id, H5F_file_space_type_t strategy, hsize_t threshold); /** @@ -10342,6 +10367,7 @@ H5_DLL herr_t H5Pset_file_space(hid_t plist_id, H5F_file_space_type_t strategy, * * \details Maps to the function H5Pget_file_space_strategy() * + * \since 1.10.0 * */ H5_DLL herr_t H5Pget_file_space(hid_t plist_id, H5F_file_space_type_t *strategy, hsize_t *threshold); diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h index 3f63d59..a28262c 100644 --- a/src/H5Rpublic.h +++ b/src/H5Rpublic.h @@ -143,6 +143,8 @@ extern "C" { * H5Rdestroy() should be used to release the resource from the * reference. * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rcreate_object(hid_t loc_id, const char *name, hid_t oapl_id, H5R_ref_t *ref_ptr); @@ -179,6 +181,8 @@ H5_DLL herr_t H5Rcreate_object(hid_t loc_id, const char *name, hid_t oapl_id, H5 * H5Rdestroy() should be used to release the resource from the * reference. * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rcreate_region(hid_t loc_id, const char *name, hid_t space_id, hid_t oapl_id, H5R_ref_t *ref_ptr); @@ -216,6 +220,8 @@ H5_DLL herr_t H5Rcreate_region(hid_t loc_id, const char *name, hid_t space_id, h * H5Rdestroy() should be used to release the resource from the * reference. * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rcreate_attr(hid_t loc_id, const char *name, const char *attr_name, hid_t oapl_id, H5R_ref_t *ref_ptr); @@ -237,6 +243,8 @@ H5_DLL herr_t H5Rcreate_attr(hid_t loc_id, const char *name, const char *attr_na * \ref H5R_ref_t is defined in H5Rpublic.h as: * \snippet this H5R_ref_t_snip * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rdestroy(H5R_ref_t *ref_ptr); @@ -265,6 +273,8 @@ H5_DLL herr_t H5Rdestroy(H5R_ref_t *ref_ptr); * \ref H5R_ref_t is defined in H5Rpublic.h as: * \snippet this H5R_ref_t_snip * + * \since 1.12.0 + * */ H5_DLL H5R_type_t H5Rget_type(const H5R_ref_t *ref_ptr); @@ -287,6 +297,8 @@ H5_DLL H5R_type_t H5Rget_type(const H5R_ref_t *ref_ptr); * \ref H5R_ref_t is defined in H5Rpublic.h as: * \snippet this H5R_ref_t_snip * + * \since 1.12.0 + * */ H5_DLL htri_t H5Requal(const H5R_ref_t *ref1_ptr, const H5R_ref_t *ref2_ptr); @@ -305,6 +317,8 @@ H5_DLL htri_t H5Requal(const H5R_ref_t *ref1_ptr, const H5R_ref_t *ref2_ptr); * \p src_ref_ptr points to the reference to copy, and \p dst_ref_ptr is the * pointer to the destination reference. * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rcopy(const H5R_ref_t *src_ref_ptr, H5R_ref_t *dst_ref_ptr); @@ -339,6 +353,8 @@ H5_DLL herr_t H5Rcopy(const H5R_ref_t *src_ref_ptr, H5R_ref_t *dst_ref_ptr); * the appropriate close function, such as H5Oclose() or H5Dclose() * for datasets. * + * \since 1.12.0 + * */ H5_DLL hid_t H5Ropen_object(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id); @@ -346,6 +362,9 @@ H5_DLL hid_t H5Ropen_object(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Ropen_object} + * + * \since 1.14.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Ropen_object_async(const char *app_file, const char *app_func, unsigned app_line, @@ -385,6 +404,8 @@ H5_DLL hid_t H5Ropen_object_async(unsigned app_line, H5R_ref_t *ref_ptr, hid_t r * Use H5Sclose() to release the dataspace identifier returned by * this function when the identifier is no longer needed. * + * \since 1.12.0 + * */ H5_DLL hid_t H5Ropen_region(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id); @@ -392,6 +413,9 @@ H5_DLL hid_t H5Ropen_region(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Ropen_region} + * + * \since 1.14.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Ropen_region_async(const char *app_file, const char *app_func, unsigned app_line, @@ -427,6 +451,8 @@ H5_DLL hid_t H5Ropen_region_async(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t oapl_ * The attribute opened with this function should be closed with * H5Aclose() when it is no longer needed. * + * \since 1.12.0 + * */ H5_DLL hid_t H5Ropen_attr(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id); @@ -434,6 +460,8 @@ H5_DLL hid_t H5Ropen_attr(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id); * -------------------------------------------------------------------------- * \ingroup ASYNC * \async_variant_of{H5Ropen_attr} + * + * \since 1.14.0 */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Ropen_attr_async(const char *app_file, const char *app_func, unsigned app_line, @@ -469,6 +497,8 @@ H5_DLL hid_t H5Ropen_attr_async(H5R_ref_t *ref_ptr, hid_t rapl_id, hid_t aapl_id * referenced object type are as followed (defined in H5Opublic.h): * \snippet H5Opublic.h H5O_type_t_snip * + * \since 1.12.0 + * */ H5_DLL herr_t H5Rget_obj_type3(H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *obj_type); @@ -498,6 +528,8 @@ H5_DLL herr_t H5Rget_obj_type3(H5R_ref_t *ref_ptr, hid_t rapl_id, H5O_type_t *ob * passed in for size in the second call to H5Rget_file_name(), * which will retrieve the actual name. * + * \since 1.12.0 + * */ H5_DLL ssize_t H5Rget_file_name(const H5R_ref_t *ref_ptr, char *name, size_t size); @@ -544,6 +576,8 @@ H5_DLL ssize_t H5Rget_file_name(const H5R_ref_t *ref_ptr, char *name, size_t siz * if there are multiple links pointing to it. This function may * return any one of these paths. * + * \since 1.12.0 + * */ H5_DLL ssize_t H5Rget_obj_name(H5R_ref_t *ref_ptr, hid_t rapl_id, char *name, size_t size); @@ -571,6 +605,8 @@ H5_DLL ssize_t H5Rget_obj_name(H5R_ref_t *ref_ptr, hid_t rapl_id, char *name, si * be passed in for size in the second call to H5Rget_attr_name(), * which will retrieve the actual name. * + * \since 1.12.0 + * */ H5_DLL ssize_t H5Rget_attr_name(const H5R_ref_t *ref_ptr, char *name, size_t size); @@ -663,7 +699,8 @@ H5_DLL ssize_t H5Rget_attr_name(const H5R_ref_t *ref_ptr, char *name, size_t siz * * \version 1.8.0 Function H5Rget_obj_type() renamed to H5Rget_obj_type1() and * deprecated in this release. - * \since 1.6.0 + * + * \since 1.2.0 * */ H5_DLL H5G_obj_t H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *ref); @@ -705,7 +742,7 @@ H5_DLL H5G_obj_t H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *ref * * \version 1.10.0 Function H5Rdereference() renamed to H5Rdereference1() and * deprecated in this release. - * \since 1.8.0 + * \since 1.0.0 * */ H5_DLL hid_t H5Rdereference1(hid_t obj_id, H5R_type_t ref_type, const void *ref); @@ -742,7 +779,7 @@ H5_DLL hid_t H5Rdereference1(hid_t obj_id, H5R_type_t ref_type, const void *ref) * dataset region references and should be set to -1 if the reference * is an object reference, #H5R_OBJECT. * - * \since 1.8.0 + * \since 1.0.0 */ H5_DLL herr_t H5Rcreate(void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id); @@ -873,6 +910,8 @@ H5_DLL hid_t H5Rdereference2(hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, c * Use H5Sclose() to release the dataspace identifier returned by this * function when the identifier is no longer needed. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Rget_region(hid_t dataset, H5R_type_t ref_type, const void *ref); diff --git a/src/H5Tpublic.h b/src/H5Tpublic.h index 1a16301..a117075 100644 --- a/src/H5Tpublic.h +++ b/src/H5Tpublic.h @@ -1044,7 +1044,7 @@ H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST64_g; * * \see H5Tclose() * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL hid_t H5Tcreate(H5T_class_t type, size_t size); @@ -1069,6 +1069,8 @@ H5_DLL hid_t H5Tcreate(H5T_class_t type, size_t size); * The returned datatype identifier should be released with H5Tclose() * to prevent resource leaks. * + * \since 1.0.0 + * */ H5_DLL hid_t H5Tcopy(hid_t type_id); /** @@ -1084,6 +1086,8 @@ H5_DLL hid_t H5Tcopy(hid_t type_id); * through this datatype identifier is illegal. Failure to release * a datatype with this call will result in resource leaks. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Tclose(hid_t type_id); /** @@ -1091,6 +1095,8 @@ H5_DLL herr_t H5Tclose(hid_t type_id); * * \brief Asynchronous version of H5Tclose(). * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Tclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t type_id, @@ -1111,7 +1117,7 @@ H5_DLL herr_t H5Tclose_async(hid_t type_id, hid_t es_id); * \details H5Tequal() determines whether two datatype identifiers refer to * the same datatype. * - * \since 1.6 or earlier + * \since 1.0.0 * */ H5_DLL htri_t H5Tequal(hid_t type1_id, hid_t type2_id); @@ -1130,6 +1136,8 @@ H5_DLL htri_t H5Tequal(hid_t type1_id, hid_t type2_id); * inadvertently change or delete a predefined type. Once a datatype * is locked it can never be unlocked. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Tlock(hid_t type_id); /** @@ -1185,6 +1193,8 @@ H5_DLL herr_t H5Tcommit2(hid_t loc_id, const char *name, hid_t type_id, hid_t lc * * \brief Asynchronous version of H5Tcommit2(). * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL herr_t H5Tcommit_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, @@ -1223,6 +1233,8 @@ H5_DLL hid_t H5Topen2(hid_t loc_id, const char *name, hid_t tapl_id); * * \brief Asynchronous version of H5Topen2(). * + * \since 1.12.0 + * */ #ifndef H5_DOXYGEN H5_DLL hid_t H5Topen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, @@ -1322,7 +1334,7 @@ H5_DLL hid_t H5Tget_create_plist(hid_t type_id); * * \version 1.8.0 Fortran API was added * - * \since 1.6 or earlier + * \since 1.0.0 * */ H5_DLL htri_t H5Tcommitted(hid_t type_id); @@ -1380,6 +1392,8 @@ H5_DLL herr_t H5Tencode(hid_t obj_id, void *buf, size_t *nalloc); * with H5Tclose() when the identifier is no longer needed so that * resource leaks will not develop. * + * \since 1.2.0 + * */ H5_DLL hid_t H5Tdecode(const void *buf); /** @@ -1403,7 +1417,7 @@ H5_DLL hid_t H5Tdecode(const void *buf); * * \return \herr_t * - * \since 1.10.0 C function introduced with this release. + * \since 1.10.0 * * \see H5Dflush() * H5Drefresh() @@ -1439,7 +1453,7 @@ H5_DLL herr_t H5Tflush(hid_t type_id); * datatype. The reopened datatype is automatically re-registered * with the same identifier. * - * \since 1.2.0 + * \since 1.10.0 * */ H5_DLL herr_t H5Trefresh(hid_t type_id); @@ -1469,7 +1483,7 @@ H5_DLL herr_t H5Trefresh(hid_t type_id); * datatypes; a compound datatype can have a member which is a * compound datatype. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tinsert(hid_t parent_id, const char *name, size_t offset, hid_t member_id); @@ -1485,7 +1499,7 @@ H5_DLL herr_t H5Tinsert(hid_t parent_id, const char *name, size_t offset, hid_t * \details H5Tpack() recursively removes padding from within a compound * datatype to make it more efficient (space-wise) to store that data. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tpack(hid_t type_id); @@ -1631,6 +1645,8 @@ H5_DLL herr_t H5Tenum_valueof(hid_t type, const char *name, void *value /*out*/) * the array being of the string or character base type.\n * To create a variable-length string datatype, see \ref_vlen_strings. * + * \since 1.2.0 + * */ H5_DLL hid_t H5Tvlen_create(hid_t base_id); @@ -1719,6 +1735,8 @@ H5_DLL int H5Tget_array_dims2(hid_t type_id, hsize_t dims[]); * maximum size of an opaque datatype tag, was added in * H5Tpublic.h. * + * \since 1.2.0 + * */ H5_DLL herr_t H5Tset_tag(hid_t type, const char *tag); /** @@ -1737,6 +1755,8 @@ H5_DLL herr_t H5Tset_tag(hid_t type, const char *tag); * \attention The tag is returned via a pointer to an allocated string, which * the caller must free. * + * \since 1.2.0 + * */ H5_DLL char *H5Tget_tag(hid_t type); @@ -1758,6 +1778,8 @@ H5_DLL char *H5Tget_tag(hid_t type); * with H5Tclose() when the identifier is no longer needed so that * resource leaks will not develop. * + * \since 1.2.0 + * */ H5_DLL hid_t H5Tget_super(hid_t type); /** @@ -1781,6 +1803,8 @@ H5_DLL hid_t H5Tget_super(hid_t type); * be readable and modifiable only on the originating computing * platform; it will not be portable to other platforms. * + * \since 1.0.0 + * */ H5_DLL H5T_class_t H5Tget_class(hid_t type_id); /** @@ -1835,7 +1859,7 @@ H5_DLL htri_t H5Tdetect_class(hid_t type_id, H5T_class_t cls); * * \see H5Tset_size() * - * \since 1.2.0 + * \since 1.0.0 */ H5_DLL size_t H5Tget_size(hid_t type_id); /** @@ -1860,7 +1884,7 @@ H5_DLL size_t H5Tget_size(hid_t type_id); * but all other members have byte order #H5T_ORDER_LE, H5Tget_order() * will return #H5T_ORDER_LE for the compound datatype. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_order_t H5Tget_order(hid_t type_id); @@ -1880,7 +1904,7 @@ H5_DLL H5T_order_t H5Tget_order(hid_t type_id); * unless padding is present, is 8 times larger than the value * returned by H5Tget_size(). * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL size_t H5Tget_precision(hid_t type_id); @@ -1909,7 +1933,7 @@ H5_DLL size_t H5Tget_precision(hid_t type_id); * 3: [0x22] [ pad] [ pad] [0x11] * \endcode * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL int H5Tget_offset(hid_t type_id); @@ -1928,7 +1952,7 @@ H5_DLL int H5Tget_offset(hid_t type_id); * most-significant bit padding. Valid padding types are: * \snippet this H5T_pad_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tget_pad(hid_t type_id, H5T_pad_t *lsb /*out*/, H5T_pad_t *msb /*out*/); @@ -1945,7 +1969,7 @@ H5_DLL herr_t H5Tget_pad(hid_t type_id, H5T_pad_t *lsb /*out*/, H5T_pad_t *msb / * Valid types are: * \snippet this H5T_sign_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_sign_t H5Tget_sign(hid_t type_id); @@ -1969,7 +1993,7 @@ H5_DLL H5T_sign_t H5Tget_sign(hid_t type_id); * datatype. Bits are numbered with the least significant bit number * zero. Any (or even all) of the arguments can be null pointers. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tget_fields(hid_t type_id, size_t *spos /*out*/, size_t *epos /*out*/, size_t *esize /*out*/, @@ -1985,7 +2009,7 @@ H5_DLL herr_t H5Tget_fields(hid_t type_id, size_t *spos /*out*/, size_t *epos /* * * \details H5Tget_ebias() retrieves the exponent bias of a floating-point type. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL size_t H5Tget_ebias(hid_t type_id); @@ -2004,7 +2028,7 @@ H5_DLL size_t H5Tget_ebias(hid_t type_id); * floating-point datatype. Valid normalization types are: * \snippet this H5T_norm_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_norm_t H5Tget_norm(hid_t type_id); @@ -2023,7 +2047,7 @@ H5_DLL H5T_norm_t H5Tget_norm(hid_t type_id); * bits in floating-point datatypes. Valid padding types are: * \snippet this H5T_pad_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_pad_t H5Tget_inpad(hid_t type_id); @@ -2044,7 +2068,7 @@ H5_DLL H5T_pad_t H5Tget_inpad(hid_t type_id); * values returned are: * \str_pad_type * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_str_t H5Tget_strpad(hid_t type_id); @@ -2061,7 +2085,7 @@ H5_DLL H5T_str_t H5Tget_strpad(hid_t type_id); * \details H5Tget_nmembers() retrieves the number of fields in a compound * datatype or the number of members of an enumeration datatype. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL int H5Tget_nmembers(hid_t type_id); @@ -2088,7 +2112,7 @@ H5_DLL int H5Tget_nmembers(hid_t type_id); * the field. The caller must subsequently free the buffer with * H5free_memory(). * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL char *H5Tget_member_name(hid_t type_id, unsigned membno); @@ -2110,7 +2134,7 @@ H5_DLL char *H5Tget_member_name(hid_t type_id, unsigned membno); * Fields are stored in no particular order with index values of 0 * through N-1, where N is the value returned by H5Tget_nmembers() . * - * \since 1.2.0 + * \since 1.4.0 * */ H5_DLL int H5Tget_member_index(hid_t type_id, const char *name); @@ -2134,7 +2158,7 @@ H5_DLL int H5Tget_member_index(hid_t type_id, const char *name); * * \version 1.6.4 \p member_no parameter type changed to unsigned. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL size_t H5Tget_member_offset(hid_t type_id, unsigned membno); @@ -2155,7 +2179,7 @@ H5_DLL size_t H5Tget_member_offset(hid_t type_id, unsigned membno); * Valid class identifiers, as defined in H5Tpublic.h, are: * \snippet this H5T_class_t_snip * - * \since 1.2.0 + * \since 1.4.0 * */ H5_DLL H5T_class_t H5Tget_member_class(hid_t type_id, unsigned membno); @@ -2176,7 +2200,7 @@ H5_DLL H5T_class_t H5Tget_member_class(hid_t type_id, unsigned membno); * * \version 1.6.4 \p membno parameter type changed to unsigned. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL hid_t H5Tget_member_type(hid_t type_id, unsigned membno); @@ -2203,7 +2227,7 @@ H5_DLL hid_t H5Tget_member_type(hid_t type_id, unsigned membno); * of that base type. If the size is unknown, you can determine it * with H5Tget_size(). * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tget_member_value(hid_t type_id, unsigned membno, void *value /*out*/); @@ -2221,7 +2245,7 @@ H5_DLL herr_t H5Tget_member_value(hid_t type_id, unsigned membno, void *value /* * Valid character set types are: * \csets * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL H5T_cset_t H5Tget_cset(hid_t type_id); @@ -2378,7 +2402,7 @@ H5_DLL hid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction); * * \see H5Tget_size() * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_size(hid_t type_id, size_t size); @@ -2417,7 +2441,7 @@ H5_DLL herr_t H5Tset_size(hid_t type_id, size_t size); * have the same byte order. * \li Opaque datatypes: Byte order can be set but has no effect. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_order(hid_t type_id, H5T_order_t order); @@ -2447,7 +2471,7 @@ H5_DLL herr_t H5Tset_order(hid_t type_id, H5T_order_t order); * locations and sizes of the sign, mantissa, and exponent fields * first. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_precision(hid_t type_id, size_t prec); @@ -2481,7 +2505,7 @@ H5_DLL herr_t H5Tset_precision(hid_t type_id, size_t prec); * * The offset of an #H5T_STRING cannot be set to anything but zero. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_offset(hid_t type_id, size_t offset); @@ -2517,7 +2541,7 @@ H5_DLL herr_t H5Tset_pad(hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb); * \details H5Tset_sign() sets the sign property for an integer type: * \sign_prop * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign); @@ -2544,7 +2568,7 @@ H5_DLL herr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign); * Fields are not allowed to extend beyond the number of bits of * precision, nor are they allowed to overlap with one another. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_fields(hid_t type_id, size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize); @@ -2560,7 +2584,7 @@ H5_DLL herr_t H5Tset_fields(hid_t type_id, size_t spos, size_t epos, size_t esiz * * \details H5Tset_ebias() sets the exponent bias of a floating-point type. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_ebias(hid_t type_id, size_t ebias); @@ -2578,7 +2602,7 @@ H5_DLL herr_t H5Tset_ebias(hid_t type_id, size_t ebias); * datatype. Valid normalization types are: * \snippet this H5T_norm_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_norm(hid_t type_id, H5T_norm_t norm); @@ -2599,7 +2623,7 @@ H5_DLL herr_t H5Tset_norm(hid_t type_id, H5T_norm_t norm); * padding types are: * \snippet this H5T_pad_t_snip * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_inpad(hid_t type_id, H5T_pad_t pad); @@ -2632,7 +2656,7 @@ H5_DLL herr_t H5Tset_inpad(hid_t type_id, H5T_pad_t pad); * string datatype while H5Pset_char_encoding() sets the character * set used for an HDF5 link or attribute name. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_cset(hid_t type_id, H5T_cset_t cset); @@ -2664,7 +2688,7 @@ H5_DLL herr_t H5Tset_cset(hid_t type_id, H5T_cset_t cset); * When converting from a shorter string to a longer string, the * longer string is padded on the end by appending nulls or spaces. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL herr_t H5Tset_strpad(hid_t type_id, H5T_str_t strpad); @@ -2708,6 +2732,8 @@ H5_DLL herr_t H5Tset_strpad(hid_t type_id, H5T_str_t strpad); * \version 1.6.3 \p nelmts parameter type changed to size_t. * \version 1.4.0 \p nelmts parameter type changed to hsize_t. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Tconvert(hid_t src_id, hid_t dst_id, size_t nelmts, void *buf, void *background, hid_t plist_id); @@ -2829,7 +2855,7 @@ H5_DLL herr_t H5Tcommit1(hid_t loc_id, const char *name, hid_t type_id); * \version 1.8.0 Function H5Topen() renamed to H5Topen1() and deprecated in * this release. * - * \since 1.2.0 + * \since 1.0.0 * */ H5_DLL hid_t H5Topen1(hid_t loc_id, const char *name); @@ -2864,6 +2890,7 @@ H5_DLL hid_t H5Topen1(hid_t loc_id, const char *name); * * \version 1.8.0 Function H5Tarray_create() renamed to H5Tarray_create1() * and deprecated in this release. + * * \since 1.4.0 * */ @@ -2892,7 +2919,8 @@ H5_DLL hid_t H5Tarray_create1(hid_t base_id, int ndims, const hsize_t dim[/* ndi * * \version 1.8.0 Function H5Tarray_create() renamed to H5Tarray_create1() * and deprecated in this release. - * \since 1.2.0 + * + * \since 1.4.0 * */ H5_DLL int H5Tget_array_dims1(hid_t type_id, hsize_t dims[], int perm[]); diff --git a/src/H5Zdevelop.h b/src/H5Zdevelop.h index 736c283..fb3b71b 100644 --- a/src/H5Zdevelop.h +++ b/src/H5Zdevelop.h @@ -145,6 +145,9 @@ typedef herr_t (*H5Z_set_local_func_t)(hid_t dcpl_id, hid_t type_id, hid_t space * The return value from the filter is the number of bytes in the * output buffer. If an error occurs then the function should return * zero and leave all pointer arguments unchanged. + * + * \since 1.0.0 + * */ //! typedef size_t (*H5Z_func_t)(unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[], @@ -379,6 +382,8 @@ extern "C" { * a new #H5Z_class_t struct and new set local and can apply * callback functions. * + * \since 1.0.0 + * */ H5_DLL herr_t H5Zregister(const void *cls); /** diff --git a/src/H5Zpublic.h b/src/H5Zpublic.h index d906e3c..44d91c0 100644 --- a/src/H5Zpublic.h +++ b/src/H5Zpublic.h @@ -304,7 +304,7 @@ H5_DLL htri_t H5Zfilter_avail(H5Z_filter_t id); * such as H5Pset_szip(), that might require a particular filter * configuration. * - * \since 1.6.3 + * \since 1.6.0 */ H5_DLL herr_t H5Zget_filter_info(H5Z_filter_t filter, unsigned int *filter_config_flags); diff --git a/src/H5public.h b/src/H5public.h index 8fce3f4..fed8c2b 100644 --- a/src/H5public.h +++ b/src/H5public.h @@ -429,6 +429,9 @@ extern "C" { * H5open() before an application issues any other function calls to * the HDF5 library, as there are no damaging side effects in calling * it more than once. + * + * \since 1.0.0 + * */ H5_DLL herr_t H5open(void); /** @@ -468,6 +471,9 @@ H5_DLL herr_t H5atclose(H5_atclose_func_t func, void *ctx); * generally called when the application calls exit(), but may be * called earlier in the event of an emergency shutdown or out of a * desire to free all resources used by the HDF5 library. + * + * \since 1.0.0 + * */ H5_DLL herr_t H5close(void); /** @@ -487,6 +493,9 @@ H5_DLL herr_t H5close(void); * before any other HDF5 function calls, and must be called each * time the library is loaded/linked into the application (the first * time and after it's been unloaded). + * + * \since 1.0.0 + * */ H5_DLL herr_t H5dont_atexit(void); /** @@ -507,6 +516,9 @@ H5_DLL herr_t H5dont_atexit(void); * * \note The library automatically garbage collects all the free lists when the * application ends. + * + * \since 1.4.0 + * */ H5_DLL herr_t H5garbage_collect(void); /** @@ -559,7 +571,7 @@ H5_DLL herr_t H5garbage_collect(void); * \version 1.8.3 Function changed in this release to set factory free list * memory limits. * - * \since 1.6.0 + * \since 1.4.0 */ H5_DLL herr_t H5set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim); @@ -595,6 +607,8 @@ H5_DLL herr_t H5get_free_list_sizes(size_t *reg_size, size_t *arr_size, size_t * * of the version of the HDF5 library which is linked to the * application. * + * \since 1.0.0 + * */ H5_DLL herr_t H5get_libversion(unsigned *majnum, unsigned *minnum, unsigned *relnum); /** @@ -643,6 +657,8 @@ H5_DLL herr_t H5get_libversion(unsigned *majnum, unsigned *minnum, unsigned *rel * informational warning is printed but the application is allowed to * run. * + * \since 1.0.0 + * */ H5_DLL herr_t H5check_version(unsigned majnum, unsigned minnum, unsigned relnum); /** @@ -675,6 +691,9 @@ H5_DLL herr_t H5is_library_terminating(hbool_t *is_terminating); * data structures with a mutex. In certain circumstances, it may be * useful to determine, at run-time, whether the linked HDF5 library * was built with the thread-safety feature enabled. + * + * \since 1.10.0 + * */ H5_DLL herr_t H5is_library_threadsafe(hbool_t *is_ts); /** -- cgit v0.12