Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc versions #3903

Merged
merged 17 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/H5Dpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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);

Expand All @@ -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);

Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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*/);
Expand Down Expand Up @@ -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()
*
*/
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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()
*
Expand Down Expand Up @@ -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[]);
Expand Down Expand Up @@ -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);

Expand Down
20 changes: 20 additions & 0 deletions src/H5Epublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
//! <!-- [H5E_walk1_t_snip] -->
Expand All @@ -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);
//! <!-- [H5E_auto1_t_snip] -->
Expand All @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand All @@ -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);
/**
Expand All @@ -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 */
Expand Down
40 changes: 40 additions & 0 deletions src/H5Fpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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()
*
*/
Expand All @@ -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,
Expand Down Expand Up @@ -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);
/**
Expand All @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand All @@ -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);
/**
Expand Down Expand Up @@ -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);
/**
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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);
/**
Expand Down
Loading