Hdf5 1 10 doxygen merges (#684)

* HDFFV-10865 - merge from dev, HDFArray perf fix.

* Remove duplicate setting

* Whitespace changes after clang format

* Undo version 11 clang format changes

* Merge CMake changes from develop

* test testing script merge from develop

* Update supported platforms

* PR#3 merge from develop

* Merge gcc 10 diagnostics option from develop

* Merge #318 OSX changes from develop

* Merge small changes from develop

* Minor non-space formatting changes

* #386 copyright corrections for java folder

* Merges from develop

#358 patches from vtk
#361 fix header guard spelling

* Merge updates

#358 patches from vtk
#361 fix header guard spelling

* format fix

* Fix missing underscore and make H5public.h closer to dev

* Merges from develop

#340 clang -Wformat-security warnings
#360 Fixed uninitialized warnings
header guard underscore cleanup
JNI cleanup

* format alignment

* Add missing test ref file

* Merge #380 from develop

* Finish java merges from develop

* Fix java issues with tests and javadoc

* Correct use of attribute access plist

* Remove debug code

* Remove unused variable

* Change file access to read only for java tests

* Split clang format operations.

* More javadoc comments

* Remove pre-split setting

* format source

* Change windows TS to use older VS.

* Mostly all javadoc fixes, one argument rename.

* synch file

* Merge of long double fix and compiler flags

* HDFFV-11229 merge changes from develop

* HDFFV-11229 correct test script

* 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

* minor whitespace

* remove unneeded macro

* Committing clang-format changes

* 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.

* Fortran target depends

* Remove incorrect source attribute

* Revert define removal

* printf specifiers and VS2015 min changes

* Committing clang-format changes

* Add time struct

* TRILAB-227 and tools debug merges from develop

* Merge various changes from dev

* Issue #669 remove version from pkgcfg filename

* remove version from h5cc script

* doxygen changes merged from develop

* Committing clang-format changes

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

1 files changed, 86 insertions, 2 deletions

diff --git a/src/H5FDpublic.h b/src/H5FDpublic.h
index edcea52..36f37f0 100644
--- a/src/H5FDpublic.h
+++ b/src/H5FDpublic.h
@@ -328,29 +328,113 @@ struct H5FD_t {
     hbool_t paged_aggr; /* Paged aggregation for file space is enabled or not */
 };
 
-/* Define enum for the source of file image callbacks */
+/**
+ * Define enum for the source of file image callbacks
+ */
+//! <!-- [H5FD_file_image_op_t_snip] -->
 typedef enum {
     H5FD_FILE_IMAGE_OP_NO_OP,
     H5FD_FILE_IMAGE_OP_PROPERTY_LIST_SET,
+    /**< Passed to the \p image_malloc and \p image_memcpy callbacks when a
+     * file image buffer is to be copied while being set in a file access
+     * property list (FAPL)*/
     H5FD_FILE_IMAGE_OP_PROPERTY_LIST_COPY,
+    /**< Passed to the \p image_malloc and \p image_memcpy callbacks
+     * when a file image buffer is to be copied when a FAPL is copied*/
     H5FD_FILE_IMAGE_OP_PROPERTY_LIST_GET,
+    /**<Passed to the \p image_malloc and \p image_memcpy callbacks when
+     * a file image buffer is to be copied while being retrieved from a FAPL*/
     H5FD_FILE_IMAGE_OP_PROPERTY_LIST_CLOSE,
+    /**<Passed to the \p image_free callback when a file image
+     * buffer is to be released during a FAPL close operation*/
     H5FD_FILE_IMAGE_OP_FILE_OPEN,
+    /**<Passed to the \p image_malloc and
+     * \p image_memcpy callbackswhen a
+     * file image buffer is to be copied during a file open operation \n
+     * While the file image being opened will typically be copied from a
+     * FAPL, this need not always be the case. For example, the core file
+     * driver, also known as the memory file driver, takes its initial
+     * image from a file.*/
     H5FD_FILE_IMAGE_OP_FILE_RESIZE,
+    /**<Passed to the \p image_realloc callback when a file driver needs
+     * to resize an image buffer*/
     H5FD_FILE_IMAGE_OP_FILE_CLOSE
+    /**<Passed to the \p image_free callback when an image buffer is to
+     * be released during a file close operation*/
 } H5FD_file_image_op_t;
+//! <!-- [H5FD_file_image_op_t_snip] -->
 
-/* Define structure to hold file image callbacks */
+/**
+ * Define structure to hold file image callbacks
+ */
+//! <!-- [H5FD_file_image_callbacks_t_snip] -->
 typedef struct {
+    /**
+     * \param[in] size Size in bytes of the file image buffer to allocate
+     * \param[in] file_image_op A value from H5FD_file_image_op_t indicating
+     *                          the operation being performed on the file image
+     *                          when this callback is invoked
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [image_malloc_snip] -->
     void *(*image_malloc)(size_t size, H5FD_file_image_op_t file_image_op, void *udata);
+    //! <!-- [image_malloc_snip] -->
+    /**
+     * \param[in] dest Address of the destination buffer
+     * \param[in] src Address of the source buffer
+     * \param[in] file_image_op A value from #H5FD_file_image_op_t indicating
+     *                          the operation being performed on the file image
+     *                          when this callback is invoked
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [image_memcpy_snip] -->
     void *(*image_memcpy)(void *dest, const void *src, size_t size, H5FD_file_image_op_t file_image_op,
                           void *udata);
+    //! <!-- [image_memcpy_snip] -->
+    /**
+     * \param[in] ptr Pointer to the buffer being reallocated
+     * \param[in] file_image_op A value from #H5FD_file_image_op_t indicating
+     *                          the operation being performed on the file image
+     *                          when this callback is invoked
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [image_realloc_snip] -->
     void *(*image_realloc)(void *ptr, size_t size, H5FD_file_image_op_t file_image_op, void *udata);
+    //! <!-- [image_realloc_snip] -->
+    /**
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [image_free_snip] -->
     herr_t (*image_free)(void *ptr, H5FD_file_image_op_t file_image_op, void *udata);
+    //! <!-- [image_free_snip] -->
+    /**
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [udata_copy_snip] -->
     void *(*udata_copy)(void *udata);
+    //! <!-- [udata_copy_snip] -->
+    /**
+     * \param[in] udata Value passed in in the H5Pset_file_image_callbacks
+     *            parameter \p udata
+     */
+    //! <!-- [udata_free_snip] -->
     herr_t (*udata_free)(void *udata);
+    //! <!-- [udata_free_snip] -->
+    /**
+     * \brief The final field in the #H5FD_file_image_callbacks_t struct,
+     *        provides a pointer to user-defined data. This pointer will be
+     *        passed to the image_malloc, image_memcpy, image_realloc, and
+     *        image_free callbacks. Define udata as NULL if no user-defined
+     *        data is provided.
+     */
     void *udata;
 } H5FD_file_image_callbacks_t;
+//! <!-- [H5FD_file_image_callbacks_t_snip] -->
 
 #ifdef __cplusplus
 extern "C" {