summaryrefslogtreecommitdiffstats
path: root/src/H5public.h
diff options
context:
space:
mode:
authorGerd Heber <gheber@hdfgroup.org>2023-12-21 20:51:58 (GMT)
committerGitHub <noreply@github.com>2023-12-21 20:51:58 (GMT)
commit37124bc1c1d3cd2114433a6d71648fcd57fd2bcf (patch)
treeaee32ac307d45c9f7b1590733b8cbd1a473e1f22 /src/H5public.h
parent2149744b35a9ce169dc01f50371eb8622b326a60 (diff)
downloadhdf5-37124bc1c1d3cd2114433a6d71648fcd57fd2bcf.zip
hdf5-37124bc1c1d3cd2114433a6d71648fcd57fd2bcf.tar.gz
hdf5-37124bc1c1d3cd2114433a6d71648fcd57fd2bcf.tar.bz2
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>
Diffstat (limited to 'src/H5public.h')
-rw-r--r--src/H5public.h21
1 files changed, 20 insertions, 1 deletions
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);
/**