Hdf5 1 12 doxygen merge (#615)

* OESS-98 fix tools test for plugins

* sync fork

* Merge of changes from dev

* Move problem option to bottom of the list until fixed

* HDFFV-11106 - fix parsing optional args

* HDFFV-11106 add note

* grammer fix

* Whitespace after clang formatting

* Undo format version 11 changes

* Update check to working version

* Merge workflow and minor changes from develop

* Update supported platforms

* PR#3 merge from develop

* Merge gcc 10 diagnostics option from develop

* Merge #318 OSX changes from develop

* Merge serval small changes from dev

* fix typo

* Minor non-space formatting changes

* GH #386 copyright corrections for java folder

* revert because logic requires false return

* Merges from develop

#358 patches from vtk
#361 fix header guard spelling

* Remove case statement for H5I_EVENTSET

* Correct call with versioning

* Remove tabs

* Double underscore change

* Merges from develop

#340 clang -Wformat-security warnings
#360 Fixed uninitialized warnings
Remove more underscores from header guards

* Merge #380 from develop

* Correct date entry

* Split format source and commit changes on repo push

* remove pre-split setting

* Change windows TS to use older VS.

* HDFFV-11212 JNI export util and Javadoc

* Suggested review changes

* Another change found

* Committing clang-format changes

* Some Javadoc warning fixes

* Committing clang-format changes

* Updated javadoc fixes

* HDFFV-11228/9 merges from develop

* remove obsolete debug comment

* Fix conflict

* HDFFV-11229 merge changes from develop

* HDFFV-11229 merge second compare from develop

* HDFFV-11229 fix reference file

* HDFFV-11229 update autotools test script for two ref files

* HDFFV-11229 merge dev changes for long double display in tools

* Committing clang-format changes

* Update with changes from develop

* Add "option" command for clang options

* Rework CMake add_custom to use the BYPRODUCTS argument

Update pkgconfig scripts for parallel builds.
Fix install COPYING file reference.
Remove unused round defines.
Change CMake default setting of BUILD_CPP to off.

* Whitespace changes

* Rework CMake add_custom to use the BYPRODUCTS argument

* Revert CMake configure checks for round defines

* With VS 2015 minimum strdup is supported

* Doxygen comments merged from develop

* doxygen build updates

* Correct version string for map functions

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 343 insertions, 5 deletions

diff --git a/src/H5Mpublic.h b/src/H5Mpublic.h
index 004ff05..f645bc9 100644
--- a/src/H5Mpublic.h
+++ b/src/H5Mpublic.h
@@ -61,8 +61,12 @@ typedef enum H5VL_map_specific_t {
     H5VL_MAP_DELETE /* H5Mdelete                */
 } H5VL_map_specific_t;
 
-/* Callback for H5Miterate() */
+//! <!-- [H5M_iterate_t_snip] -->
+/**
+ * Callback for H5Miterate()
+ */
 typedef herr_t (*H5M_iterate_t)(hid_t map_id, const void *key, void *op_data);
+//! <!-- [H5M_iterate_t_snip] -->
 
 /********************/
 /* Public Variables */
@@ -81,25 +85,359 @@ extern "C" {
  */
 #ifdef H5_HAVE_MAP_API
 
+/**
+ * \ingroup H5M
+ *
+ * \brief Creates a map object
+ *
+ * \fgdta_loc_id
+ * \param[in] name Map object name
+ * \type_id{key_type_id}
+ * \type_id{val_type_id}
+ * \lcpl_id
+ * \mcpl_id
+ * \mapl_id
+ * \returns \hid_t{map object}
+ *
+ * \details H5Mcreate() creates a new map object for storing key-value
+ *          pairs. The in-file datatype for keys is defined by \p key_type_id
+ *          and the in-file datatype for values is defined by \p val_type_id. \p
+ *          loc_id specifies the location to create the the map object and \p
+ *          name specifies the name of the link to the map object relative to
+ *          \p loc_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL hid_t H5Mcreate(hid_t loc_id, const char *name, hid_t key_type_id, hid_t val_type_id, hid_t lcpl_id,
                        hid_t mcpl_id, hid_t mapl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief
+ *
+ * \details
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL hid_t H5Mcreate_anon(hid_t loc_id, hid_t key_type_id, hid_t val_type_id, hid_t mcpl_id, hid_t mapl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Opens a map object
+ *
+ * \fgdta_loc_id{loc_id}
+ * \param[in] name Map object name relative to \p loc_id
+ * \mapl_id
+ * \returns \hid_t{map object}
+ *
+ * \details H5Mopen() finds a map object specified by \p name under the location
+ *          specified by \p loc_id. The map object should be close with
+ *          H5Mclose() when the application is not longer interested in
+ *          accessing it.
+ *
+ * \since 1.13.0
+ *
+ */
 H5_DLL hid_t H5Mopen(hid_t loc_id, const char *name, hid_t mapl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Terminates access to a map object
+ *
+ * \map_id
+ * \returns \herr_t
+ *
+ * \details H5Mclose() closes access to a map object specified by \p map_id and
+ *          releases resources used by it.
+ *
+ *          It is illegal to subsequently use that same map identifier in calls
+ *          to other map functions.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mclose(hid_t map_id);
-H5_DLL hid_t  H5Mget_key_type(hid_t map_id);
-H5_DLL hid_t  H5Mget_val_type(hid_t map_id);
-H5_DLL hid_t  H5Mget_create_plist(hid_t map_id);
-H5_DLL hid_t  H5Mget_access_plist(hid_t map_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Gets key datatype for a map object
+ *
+ * \map_id
+ * \returns \hid_t{datatype}
+ *
+ * \details H5Mget_key_type() retrieves key datatype as stored in the file for a
+ *          map object specified by \p map_id and returns identifier for the
+ *          datatype.
+ *
+ * \since 1.12.0
+ *
+ */
+H5_DLL hid_t H5Mget_key_type(hid_t map_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Gets value datatype for a map object
+ *
+ * \map_id
+ * \returns \hid_t{datatype}
+ *
+ * \details H5Mget_val_type() retrieves value datatype as stored in the file for
+ *          a map object specified by \p map_id and returns identifier for the
+ *          datatype .
+ *
+ * \since 1.12.0
+ *
+ */
+H5_DLL hid_t H5Mget_val_type(hid_t map_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Gets creation property list for a map object
+ *
+ * \map_id
+ * \returns \hid_t{map creation property list}
+ *
+ * \details H5Mget_create_plist() returns an identifier for a copy of the
+ *          creation property list for a map object specified by \p map_id.
+ *
+ * \since 1.13.0
+ *
+ */
+H5_DLL hid_t H5Mget_create_plist(hid_t map_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Gets access property list for a map object
+ *
+ * \map_id
+ * \returns \hid_t{map access property list}
+ *
+ * \details H5Mget_access_plist() returns an identifier for a copy of the access
+ *          property list for a map object specified by \p map_id.
+ *
+ * \since 1.12.0
+ *
+ */
+H5_DLL hid_t H5Mget_access_plist(hid_t map_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Retrieves the number of key-value pairs in a map object
+ *
+ * \map_id
+ * \param[out] count The number of key-value pairs stored in the map object
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Mget_count() retrieves the number of key-value pairs stored in a
+ *          map specified by map_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mget_count(hid_t map_id, hsize_t *count, hid_t dxpl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Adds a key-value pair to a map object
+ *
+ * \map_id
+ * \type_id{key_mem_type_id}
+ * \param[in] key Pointer to key buffer
+ * \type_id{val_mem_type_id}
+ * \param[in] value Pointer to value buffer
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Mput() adds a key-value pair to a map object specified by \p
+ *          map_id, or updates the value for the specified key if one was set
+ *          previously.
+ *
+ *          \p key_mem_type_id and \p val_mem_type_id specify the datatypes for
+ *          the provided key and value buffers, and if different from those used
+ *          to create the map object, the key and value will be internally
+ *          converted to the datatypes for the map object.
+ *
+ *          Any further options can be specified through the property list
+ *          \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mput(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id,
                      const void *value, hid_t dxpl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Retrieves a key-value pair from a map object
+ *
+ * \map_id
+ * \type_id{key_mem_type_id}
+ * \param[in] key Pointer to key buffer
+ * \type_id{val_mem_type_id}
+ * \param[out] value Pointer to value buffer
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Mget() retrieves from a map object specified by \p map_id, the
+ *          value associated with the provided key \p key. \p key_mem_type_id
+ *          and \p val_mem_type_id specify the datatypes for the provided key
+ *          and value buffers. If if the datatype specified by \p
+ *          key_mem_type_id is different from that used to create the map object
+ *          the key will be internally converted to the datatype for the map
+ *          object for the query, and if the datatype specified by \p
+ *          val_mem_type_id is different from that used to create the map object
+ *          the returned value will be converted to have a datatype as specified
+ *          by \p val_mem_type_id before the function returns.
+ *
+ *          Any further options can be specified through the property list
+ *          \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mget(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t val_mem_type_id, void *value,
                      hid_t dxpl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Checks if provided key exists in a map object
+ *
+ * \map_id
+ * \type_id{key_mem_type_id}
+ * \param[in] key Pointer to key buffer
+ * \param[out] exists Pointer to a buffer to return the existence status
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Mexists() checks if the provided key is stored in the map object
+ *          specified by \p map_id. If \p key_mem_type_id is different from that
+ *          used to create the map object the key will be internally converted
+ *          to the datatype for the map object for the query.
+ *
+ *          Any further options can be specified through the property list
+ *          \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mexists(hid_t map_id, hid_t key_mem_type_id, const void *key, hbool_t *exists, hid_t dxpl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Iterates over all key-value pairs in a map object
+ *
+ * \map_id
+ * \param[in,out] idx iteration index
+ * \type_id{key_mem_type_id}
+ * \param[in] op User-defined iterator function
+ * \op_data
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Miterate() iterates over all key-value pairs stored in the map
+ *          object specified by \p map_id, making the callback specified by \p
+ *          op for each. The \p idx parameter is an in/out parameter that may be
+ *          used to restart a previously interrupted iteration. At the start of
+ *          iteration \p idx should be set to 0, and to restart iteration at the
+ *          same location on a subsequent call to H5Miterate(), \p idx should be
+ *          the same value as returned by the previous call. Iterate callback is
+ *          defined as:
+ *          \snippet this H5M_iterate_t_snip
+ *          The \p key parameter is the buffer for the key for this iteration,
+ *          converted to the datatype specified by \p key_mem_type_id. The \p
+ *          op_data parameter is a simple pass through of the value passed to
+ *          H5Miterate(), which can be used to store application-defined data for
+ *          iteration. A negative return value from this function will cause
+ *          H5Miterate() to issue an error, while a positive return value will
+ *          cause H5Miterate() to stop iterating and return this value without
+ *          issuing an error. A return value of zero allows iteration to continue.
+ *
+ *          Any further options can be specified through the property list \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Miterate(hid_t map_id, hsize_t *idx, hid_t key_mem_type_id, H5M_iterate_t op, void *op_data,
                          hid_t dxpl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Iterates over all key-value pairs in a map object
+ *
+ * \loc_id
+ * \param[in] map_name Map object name relative to the location specified by \p loc_id
+ * \param[in,out] idx Iteration index
+ * \type_id{key_mem_type_id}
+ * \param[in] op User-defined iterator function
+ * \op_data
+ * \dxpl_id
+ * \lapl_id
+ * \returns \herr_t
+ *
+ * \details H5Miterate_by_name() iterates over all key-value pairs stored in the
+ *          map object specified by \p map_id, making the callback specified by
+ *          \p op for each. The \p idx parameter is an in/out parameter that may
+ *          be used to restart a previously interrupted iteration. At the start
+ *          of iteration \p idx should be set to 0, and to restart iteration at
+ *          the same location on a subsequent call to H5Miterate(), \p idx
+ *          should be the same value as returned by the previous call. Iterate
+ *          callback is defined as:
+ *          \snippet this H5M_iterate_t_snip
+ *          The\p key parameter is the buffer for the key for this iteration,
+ *          converted to the datatype specified by \p key_mem_type_id. The \p
+ *          op_data parameter is a simple pass through of the value passed to
+ *          H5Miterate(), which can be used to store application-defined data
+ *          for iteration. A negative return value from this function will cause
+ *          H5Miterate() to issue an error, while a positive return value will cause
+ *          H5Miterate() to stop iterating and return this value without issuing an
+ *          error. A return value of zero allows iteration to continue.
+ *
+ *          Any further options can be specified through the property list \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Miterate_by_name(hid_t loc_id, const char *map_name, hsize_t *idx, hid_t key_mem_type_id,
                                  H5M_iterate_t op, void *op_data, hid_t dxpl_id, hid_t lapl_id);
+
+/**
+ * \ingroup H5M
+ *
+ * \brief Deletes a key-value pair from a map object
+ *
+ * \map_id
+ * \type_id{key_mem_type_id}
+ * \param[in] key Pointer to key buffer
+ * \dxpl_id
+ * \returns \herr_t
+ *
+ * \details H5Mdelete() deletes a key-value pair from the map object specified
+ *          by \p map_id. \p key_mem_type_id specifies the datatype for the
+ *          provided key buffer key, and if different from that used to create
+ *          the map object, the key will be internally converted to the datatype
+ *          for the map object.
+ *
+ *          Any further options can be specified through the property list \p dxpl_id.
+ *
+ * \since 1.12.0
+ *
+ */
 H5_DLL herr_t H5Mdelete(hid_t map_id, hid_t key_mem_type_id, const void *key, hid_t dxpl_id);
 
 /* Symbols defined for compatibility with previous versions of the HDF5 API.