From 1bec0ce2d785b5c0d7f4514fb50f44b524fe4f67 Mon Sep 17 00:00:00 2001 From: Scot Breitenfeld Date: Wed, 28 Sep 2022 10:52:19 -0500 Subject: Misc. Fortran Doxygen updates (#2129) --- fortran/src/H5Eff.F90 | 4 +- fortran/src/H5Off.F90 | 1 - fortran/src/H5Pff.F90 | 175 ++++++++++++++++++------------- fortran/src/H5Sff.F90 | 262 ++++++++++++++++++++++------------------------ fortran/src/H5Tff.F90 | 88 +++++----------- fortran/src/H5VLff.F90 | 20 ++-- fortran/src/H5Zff.F90 | 2 + fortran/src/H5f90proto.h | 2 - hl/fortran/src/H5DSff.F90 | 18 ++++ hl/fortran/src/H5IMff.F90 | 29 ++++- hl/fortran/src/H5LTff.F90 | 41 +++++++- hl/fortran/src/H5TBff.F90 | 22 ++++ 12 files changed, 377 insertions(+), 287 deletions(-) diff --git a/fortran/src/H5Eff.F90 b/fortran/src/H5Eff.F90 index 7e833ab..d6cf664 100644 --- a/fortran/src/H5Eff.F90 +++ b/fortran/src/H5Eff.F90 @@ -122,7 +122,7 @@ CONTAINS !! \param namelen Number of characters in the name buffer. !! \param hdferr \fortran_error !! -!! See C API: @ref char *H5Eget_major(H5E_major_t maj); +!! See C API: @ref char* H5Eget_major(H5E_major_t maj); !! SUBROUTINE h5eget_major_f(error_no, name, namelen, hdferr) INTEGER, INTENT(IN) :: error_no @@ -151,7 +151,7 @@ CONTAINS !! \param name Character string describing the error. !! \param hdferr \fortran_error !! -!! See C API: @ref char *H5Eget_minor(H5E_minor_t min); +!! See C API: @ref char* H5Eget_minor(H5E_minor_t min); !! SUBROUTINE h5eget_minor_f(error_no, name, hdferr) INTEGER, INTENT(IN) :: error_no diff --git a/fortran/src/H5Off.F90 b/fortran/src/H5Off.F90 index 274ebd5..b673b29 100644 --- a/fortran/src/H5Off.F90 +++ b/fortran/src/H5Off.F90 @@ -888,7 +888,6 @@ CONTAINS !! \param lapl_id Link access property list. (Not currently used.). !! \param fields Flags specifying the fields to include in object_info. !! -!! Fortran2003 Interface: !! See C API: @ref herr_t H5Oget_info_by_idx3(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info2_t *oinfo, unsigned fields, hid_t lapl_id); !! SUBROUTINE h5oget_info_by_idx_f(loc_id, group_name, index_field, order, n, & diff --git a/fortran/src/H5Pff.F90 b/fortran/src/H5Pff.F90 index 10b9539..82eaaf5 100644 --- a/fortran/src/H5Pff.F90 +++ b/fortran/src/H5Pff.F90 @@ -392,7 +392,7 @@ CONTAINS !! \param dims Array with dimension sizes for each chunk. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/]); +!! See C API: @ref herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[]); !! SUBROUTINE h5pset_chunk_f(prp_id, ndims, dims, hdferr) IMPLICIT NONE @@ -492,7 +492,7 @@ CONTAINS !! \param shhdr Shared object header version number. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_version(hid_t plist_id, unsigned *boot , unsigned *freelist /*out*/, unsigned *stab, unsigned *shhdr /*out*/); +!! See C API: @ref herr_t H5Pget_version(hid_t plist_id, unsigned *boot , unsigned *freelist, unsigned *stab, unsigned *shhdr); !! SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & stab, shhdr, hdferr) @@ -530,7 +530,9 @@ CONTAINS !! \param size Size of the user-block in bytes. !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_userblock_f (prp_id, size, hdferr) +!! See C API: @ref herr_t H5Pset_userblock(hid_t plist_id, hsize_t size); +!! + SUBROUTINE h5pset_userblock_f(prp_id, size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER(HSIZE_T), INTENT(IN) :: size @@ -586,7 +588,9 @@ CONTAINS !! \param sizeof_size Size of an object length in bytes. !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr) +!! See C API: @ref herr_t H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size); +!! + SUBROUTINE h5pset_sizes_f(prp_id, sizeof_addr, sizeof_size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER(SIZE_T), INTENT(IN) :: sizeof_addr @@ -616,7 +620,7 @@ CONTAINS !! \param sizeof_size Size of an object length in bytes. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_sizes(hid_t plist_id, size_t *sizeof_addr , size_t *sizeof_size /*out*/); +!! See C API: @ref herr_t H5Pget_sizes(hid_t plist_id, size_t *sizeof_addr , size_t *sizeof_size); !! SUBROUTINE h5pget_sizes_f(prp_id, sizeof_addr, sizeof_size, hdferr) IMPLICIT NONE @@ -648,7 +652,9 @@ CONTAINS !! \param lk Symbol table node size. !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_sym_k_f (prp_id, ik, lk, hdferr) +!! See C API: @ref herr_t H5Pset_sym_k(hid_t plist_id, unsigned ik, unsigned lk); +!! + SUBROUTINE h5pset_sym_k_f(prp_id, ik, lk, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(IN) :: ik @@ -677,7 +683,7 @@ CONTAINS !! \param lk Symbol table node 1/2 size. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_sym_k(hid_t plist_id, unsigned *ik , unsigned *lk /*out*/); +!! See C API: @ref herr_t H5Pget_sym_k(hid_t plist_id, unsigned *ik, unsigned *lk); !! SUBROUTINE h5pget_sym_k_f(prp_id, ik, lk, hdferr) IMPLICIT NONE @@ -707,7 +713,9 @@ CONTAINS !! \param ik 1/2 rank of chunked storage B-tree !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_istore_k_f (prp_id, ik, hdferr) +!! See C API: @ref herr_t H5Pset_istore_k(hid_t plist_id, unsigned ik); +!! + SUBROUTINE h5pset_istore_k_f(prp_id, ik, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(IN) :: ik @@ -791,7 +799,9 @@ CONTAINS !! \param prp_id File access property list identifier. !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_fapl_stdio_f (prp_id, hdferr) +!! See C API: @ref herr_t H5Pset_fapl_stdio(hid_t fapl_id); +!! + SUBROUTINE h5pset_fapl_stdio_f(prp_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(OUT) :: hdferr @@ -815,7 +825,9 @@ CONTAINS !! \param prp_id File access property list identifier. !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_fapl_sec2_f (prp_id, hdferr) +!! See C API: @ref herr_t H5Pset_fapl_sec2(hid_t fapl_id); +!! + SUBROUTINE h5pset_fapl_sec2_f(prp_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(OUT) :: hdferr @@ -873,7 +885,7 @@ CONTAINS !! \param alignment Alignment value. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_alignment(hid_t fapl_id, hsize_t *threshold , hsize_t *alignment /*out*/); +!! See C API: @ref herr_t H5Pget_alignment(hid_t fapl_id, hsize_t *threshold, hsize_t *alignment); !! SUBROUTINE h5pget_alignment_f(prp_id, threshold, alignment, hdferr) IMPLICIT NONE @@ -905,6 +917,8 @@ CONTAINS !! \param backing_store Boolean flag indicating whether to write the file contents to disk when the file is closed. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_fapl_core(hid_t fapl_id, size_t *increment, hbool_t *backing_store); +!! SUBROUTINE h5pset_fapl_core_f(prp_id, increment, backing_store, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -937,6 +951,8 @@ CONTAINS !! \param backing_store Boolean flag indicating whether to write the file contents to disk when the file is closed. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_fapl_core(hid_t fapl_id, size_t *increment, hbool_t *backing_store); +!! SUBROUTINE h5pget_fapl_core_f(prp_id, increment, backing_store, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -971,6 +987,8 @@ CONTAINS !! \param memb_plist Identifier of the file access property list to be used for each family member !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pset_fapl_family(hid_t fapl_id, hsize_t memb_size, hid_t memb_fapl_id); +!! SUBROUTINE h5pset_fapl_family_f(prp_id, memb_size, memb_plist , hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -1001,6 +1019,8 @@ CONTAINS !! \param memb_plist Identifier of the file access property list to be used for each family member !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_fapl_family(hid_t fapl_id, hsize_t *memb_size, hid_t *memb_fapl_id); +!! SUBROUTINE h5pget_fapl_family_f(prp_id, memb_size, memb_plist , hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -1071,7 +1091,7 @@ CONTAINS !! \param rdcc_w0 Preemption policy (0 or 1). !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts, /* out */ size_t *rdcc_nslots, size_t *rdcc_nbytes /*out*/, double *rdcc_w0); +!! See C API: @ref herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts, size_t *rdcc_nslots, size_t *rdcc_nbytes, double *rdcc_w0); !! SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr) IMPLICIT NONE @@ -1109,6 +1129,8 @@ CONTAINS !! \param raw_plist Identifier of the raw file access property list. !! \param hdferr \fortran_error !! +!! See C API: herr_t H5Pset_fapl_split(hid_t fapl, const char *meta_ext, hid_t meta_plist_id, const char *raw_ext, hid_t raw_plist_id); +!! SUBROUTINE h5pset_fapl_split_f(prp_id, meta_ext, meta_plist, raw_ext, raw_plist, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -1147,7 +1169,9 @@ CONTAINS !! \param gc_reference Flag for setting garbage collection on and off (1 or 0). !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_gc_references_f (prp_id, gc_reference, hdferr) +!! See C API: herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref); +!! + SUBROUTINE h5pset_gc_references_f(prp_id, gc_reference, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(IN) :: gc_reference @@ -1207,7 +1231,9 @@ CONTAINS !! \li H5D_CHUNKED_F !! \param hdferr \fortran_error !! - SUBROUTINE h5pset_layout_f (prp_id, layout, hdferr) +!! See C API: @ref herr_t H5Pset_layout(hid_t plist_id, H5D_layout_t layout); +!! + SUBROUTINE h5pset_layout_f(prp_id, layout, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(IN) :: layout @@ -1238,7 +1264,9 @@ CONTAINS !! \li H5D_CHUNKED_F !! \param hdferr \fortran_error !! - SUBROUTINE h5pget_layout_f (prp_id, layout, hdferr) +!! See C API: @ref H5D_layout_t H5Pget_layout(hid_t plist_id); +!! + SUBROUTINE h5pget_layout_f(prp_id, layout, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(OUT) :: layout @@ -1304,7 +1332,7 @@ CONTAINS !! \param nfilters Number of filters in the pipeline. !! \param hdferr \fortran_error !! - SUBROUTINE h5pget_nfilters_f (prp_id, nfilters, hdferr) + SUBROUTINE h5pget_nfilters_f(prp_id, nfilters, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(OUT) :: nfilters @@ -1337,7 +1365,7 @@ CONTAINS !! \param name Buffer to retrieve filter name. !! \param hdferr \fortran_error !! -!! See C API: @ref H5Z_filter_t H5Pget_filter2(hid_t plist_id, unsigned idx, unsigned int *flags , size_t *cd_nelmts, unsigned cd_values[] /*out*/, size_t namelen, char name[], unsigned *filter_config); +!! See C API: @ref H5Z_filter_t H5Pget_filter2(hid_t plist_id, unsigned idx, unsigned int *flags , size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config); !! SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr) IMPLICIT NONE @@ -1425,7 +1453,9 @@ CONTAINS !! \param count Number of external files for the specified dataset. !! \param hdferr \fortran_error !! - SUBROUTINE h5pget_external_count_f (prp_id, count, hdferr) +!! See C API: int H5Pget_external_count(hid_t plist_id); +!! + SUBROUTINE h5pget_external_count_f(prp_id, count, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER, INTENT(OUT) :: count @@ -1456,7 +1486,7 @@ CONTAINS !! \param bytes Size of the external file data. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_external(hid_t plist_id, unsigned idx, size_t name_size, char *name , off_t *offset, hsize_t *size /*out*/); +!! See C API: @ref herr_t H5Pget_external(hid_t plist_id, unsigned idx, size_t name_size, char *name , off_t *offset, hsize_t *size); !! SUBROUTINE h5pget_external_f(prp_id, idx, name_size, name, offset,bytes, hdferr) IMPLICIT NONE @@ -1531,7 +1561,7 @@ CONTAINS !! \param right The B-tree split ratio for right-most nodes. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_btree_ratios(hid_t plist_id, double *left , double *middle /*out*/, double *right); +!! See C API: @ref herr_t H5Pget_btree_ratios(hid_t plist_id, double *left , double *middle, double *right); !! SUBROUTINE h5pget_btree_ratios_f(prp_id, left, middle, right, hdferr) IMPLICIT NONE @@ -1698,7 +1728,7 @@ CONTAINS !! \param size Buffer size. !! \param hdferr \fortran_error !! -!! See C API: @ref size_t H5Pget_buffer(hid_t plist_id, void **tconv , void **bkg /*out*/); +!! See C API: @ref size_t H5Pget_buffer(hid_t plist_id, void **tconv, void **bkg); !! SUBROUTINE h5pget_buffer_f(plist_id, size, hdferr) IMPLICIT NONE @@ -2238,7 +2268,7 @@ CONTAINS !! truncated to fit into provided user buffer. !! \param hdferr \fortran_error !! -!! See C API: @ref char *H5Pget_class_name(hid_t pclass_id); +!! See C API: @ref char* H5Pget_class_name(hid_t pclass_id); !! SUBROUTINE h5pget_class_name_f(prp_id, name, size, hdferr) IMPLICIT NONE @@ -2855,7 +2885,7 @@ CONTAINS !! \param name Buffer to retrieve filter name. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_filter_by_id2(hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags , size_t *cd_nelmts, unsigned cd_values[] /*out*/, size_t namelen, char name[], unsigned *filter_config /*out*/); +!! See C API: @ref herr_t H5Pget_filter_by_id2(hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config); !! SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, hdferr) IMPLICIT NONE @@ -2900,7 +2930,7 @@ CONTAINS !! \param cd_values Auxiliary data for the filter. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pmodify_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[/*cd_nelmts*/]); +!! See C API: @ref herr_t H5Pmodify_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[]); !! SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, cd_values, hdferr) IMPLICIT NONE @@ -3351,6 +3381,8 @@ CONTAINS !! \param crt_intermed_group Specifies whether to create intermediate groups upon the creation of an object. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_create_intermediate_group(hid_t plist_id, unsigned *crt_intmd); +!! SUBROUTINE h5pset_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: lcpl_id @@ -3379,7 +3411,7 @@ CONTAINS !! \param crt_order_flags Creation order flag(s). !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_flags /* out */); +!! See C API: @ref herr_t H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_flags); !! SUBROUTINE h5pget_link_creation_order_f(gcpl_id, crt_order_flags, hdferr) IMPLICIT NONE @@ -3649,7 +3681,7 @@ SUBROUTINE h5pget_data_transform_f(plist_id, expression, hdferr, size) !! \param est_name_len Estimated average length of link names. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_est_link_info(hid_t plist_id, unsigned *est_num_entries /* out */, unsigned *est_name_len /* out */); +!! See C API: @ref herr_t H5Pget_est_link_info(hid_t plist_id, unsigned *est_num_entries, unsigned *est_name_len); !! SUBROUTINE h5pget_est_link_info_f(gcpl_id, est_num_entries, est_name_len, hdferr) IMPLICIT NONE @@ -3778,6 +3810,8 @@ SUBROUTINE h5pset_link_phase_change_f(gcpl_id, max_compact, min_dense, hdferr) !! \param cbuf_size Copy buffer size. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pset_fapl_direct(hid_t fapl_id, size_t alignment, size_t block_size, size_t cbuf_size); +!! SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: fapl_id @@ -3811,6 +3845,8 @@ SUBROUTINE h5pset_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdfer !! \param cbuf_size Copy buffer size. !! \param hdferr \fortran_error !! +!! See C API: @ref H5Pget_fapl_direct(hid_t fapl_id, size_t *boundary, size_t *block_size, size_t *cbuf_size); +!! SUBROUTINE h5pget_fapl_direct_f(fapl_id, alignment, block_size, cbuf_size, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: fapl_id @@ -4001,6 +4037,8 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \param crt_intermed_group Specifying whether to create intermediate groups upon the creation of an object. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_create_intermediate_group(hid_t plist_id, unsigned *crt_intmd); +!! SUBROUTINE h5pget_create_inter_group_f(lcpl_id, crt_intermed_group, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: lcpl_id @@ -4083,7 +4121,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \param rdcc_w0 Preemption policy. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pget_chunk_cache(hid_t dapl_id, size_t *rdcc_nslots , size_t *rdcc_nbytes /*out*/, double *rdcc_w0); +!! See C API: @ref herr_t H5Pget_chunk_cache(hid_t dapl_id, size_t *rdcc_nslots , size_t *rdcc_nbytes, double *rdcc_w0); !! SUBROUTINE h5pget_chunk_cache_f(dapl_id, rdcc_nslots, rdcc_nbytes, rdcc_w0, hdferr) IMPLICIT NONE @@ -4321,7 +4359,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \param value Pointer to value to set the property to. !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pregister2(hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, +!! See C API: @ref herr_t H5Pregister2(hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close); !! SUBROUTINE h5pregister_f(class, name, size, value, hdferr) INTEGER(HID_T) , INTENT(IN) :: class @@ -4347,7 +4385,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \li CHARACTER(LEN=*) !! \param hdferr \fortran_error !! -!! See C API: @ref herr_t H5Pregister2(hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, +!! See C API: @ref herr_t H5Pregister2(hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close); !! SUBROUTINE h5pregister_f(class, name, size, value, hdferr) INTEGER(HID_T) , INTENT(IN) :: class @@ -4498,7 +4536,7 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id INTEGER(HID_T), INTENT(IN) :: type_id - TYPE(C_PTR) :: fillvalue ! Fillvalue + TYPE(C_PTR) :: fillvalue INTEGER , INTENT(OUT) :: hdferr hdferr = h5pget_fill_value_c(prp_id, type_id, fillvalue) @@ -4522,8 +4560,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) END SUBROUTINE h5pset_integer -!! See C API: @ref herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/]); -!! SUBROUTINE h5pset_char(prp_id, name, value, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4559,20 +4595,18 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) DEALLOCATE(chr) END SUBROUTINE h5pset_char -!> -!! \ingroup FH5P -!! -!! \brief Queries the value of a property. -!! -!! \param prp_id Property list identifier to modify. -!! \param name Name of property to get. -!! \param value Property value, supported types are: -!! \li INTEGER -!! \li REAL -!! \li DOUBLE PRECISION -!! \li CHARACTER(LEN=*) -!! \param hdferr \fortran_error -!! + +! \brief Queries the value of a property. +! +! \param prp_id Property list identifier to modify. +! \param name Name of property to get. +! \param value Property value, supported types are: +! \li INTEGER +! \li REAL +! \li DOUBLE PRECISION +! \li CHARACTER(LEN=*) +! \param hdferr \fortran_error +! SUBROUTINE h5pget_integer(prp_id, name, value, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4589,8 +4623,6 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) END SUBROUTINE h5pget_integer -!! See C API: @ref int H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[] ); -!! SUBROUTINE h5pget_char(prp_id, name, value, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4623,18 +4655,13 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) END SUBROUTINE h5pget_char -!> -!! \ingroup FH5P -!! -!! \brief Sets a property list value -!! -!! \param prp_id Property list identifier to modify. -!! \param name Name of property to modify. -!! \param value Pointer to value to set the property to. -!! \param hdferr \fortran_error -!! -!! See C API: @ref herr_t H5Pset_page_buffer_size(hid_t plist_id, size_t buf_size, unsigned min_meta_per, unsigned min_raw_per); -!! +! \brief Sets a property list value +! +! \param prp_id Property list identifier to modify. +! \param name Name of property to modify. +! \param value Pointer to value to set the property to. +! \param hdferr \fortran_error +! SUBROUTINE h5pset_ptr(prp_id, name, value, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4647,18 +4674,14 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) hdferr = h5pset_c(prp_id, name, name_len, value) END SUBROUTINE h5pset_ptr -!> -!! \ingroup FH5P -!! -!! \brief Queries the value of a property. -!! -!! \param prp_id Property list identifier to modify. -!! \param name Name of property to get. -!! \param value Pointer to a location to which to copy the value of of the property. -!! \param hdferr \fortran_error -!! -!! See C API: @ref herr_t H5Pget_page_buffer_size(hid_t plist_id, size_t *buf_size, unsigned *min_meta_perc, unsigned *min_raw_perc); -!! + +! \brief Queries the value of a property. +! +! \param prp_id Property list identifier to modify. +! \param name Name of property to get. +! \param value Pointer to a location to which to copy the value of of the property. +! \param hdferr \fortran_error +! SUBROUTINE h5pget_ptr(prp_id, name, value, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4963,6 +4986,8 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \param info MPI-2 info object. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pset_fapl_mpio(hid_t fapl_id, MPI_Comm comm, MPI_Info info); +!! SUBROUTINE h5pset_fapl_mpio_f(prp_id, comm, info, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -4994,6 +5019,8 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \param info MPI-2 info object. !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_fapl_mpio(hid_t fapl_id, MPI_Comm *comm, MPI_Info *info); +!! SUBROUTINE h5pget_fapl_mpio_f(prp_id, comm, info, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -5026,6 +5053,8 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \li H5FD_MPIO_COLLECTIVE_F !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pset_dxpl_mpio(hid_t dxpl_id, H5FD_mpio_xfer_t xfer_mode); +!! SUBROUTINE h5pset_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id @@ -5055,6 +5084,8 @@ SUBROUTINE h5pset_attr_phase_change_f(ocpl_id, max_compact, min_dense, hdferr) !! \li H5FD_MPIO_COLLECTIVE_F !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Pget_dxpl_mpio(hid_t dxpl_id, H5FD_mpio_xfer_t *xfer_mode); +!! SUBROUTINE h5pget_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id diff --git a/fortran/src/H5Sff.F90 b/fortran/src/H5Sff.F90 index 11404d4..b068deb 100644 --- a/fortran/src/H5Sff.F90 +++ b/fortran/src/H5Sff.F90 @@ -897,61 +897,58 @@ CONTAINS DEALLOCATE(def_stride) END SUBROUTINE h5sselect_hyperslab_f -! !$! -!> -!! !$! -!! !$! NAME -!! !$! h5scombine_hyperslab_f -!! !$! -!! !$! PURPOSE -!! !$! Combine a hyperslab selection with the current -!! !$! selection for a dataspace -!! !$! -!! !$! INPUTS -!! !$! space_id - dataspace of selection to use -!! !$! operator - flag, valid values are: -!! !$! H5S_SELECT_NOOP_F -!! !$! H5S_SELECT_SET_F -!! !$! H5S_SELECT_OR_F -!! !$! H5S_SELECT_AND_F -!! !$! H5S_SELECT_XOR_F -!! !$! H5S_SELECT_NOTB_F -!! !$! H5S_SELECT_NOTA_F -!! !$! H5S_SELECT_APPEND_F -!! !$! H5S_SELECT_PREPEND_F -!! !$! start - array with hyperslab offsets -!! !$! count - number of blocks included in the -!! !$! hyperslab -!! !$! OUTPUTS -!! !$! hyper_id - identifier for the new hyperslab -!! !$! hdferr: - error code -!! !$! Success: 0 -!! !$! Failure: -1 -!! !$! OPTIONAL PARAMETERS -!! !$! stride - array with hyperslab strides -!! !$! block - array with hyperslab block sizes -!! !$! -!! !$! AUTHOR -!! !$! Elena Pourmal -!! !$! October 7, 2002 -!! !$! -!! !$! HISTORY -!! !$! -!! !$! -!! !$! NOTES -!! !$! Commented out until 1.6 ? 10/08/2002 -!! !$! -!! !$! SOURCE +! +! NAME +! h5scombine_hyperslab_f +! +! PURPOSE +! Combine a hyperslab selection with the current +! selection for a dataspace +! +! INPUTS +! space_id - dataspace of selection to use +! operator - flag, valid values are: +! H5S_SELECT_NOOP_F +! H5S_SELECT_SET_F +! H5S_SELECT_OR_F +! H5S_SELECT_AND_F +! H5S_SELECT_XOR_F +! H5S_SELECT_NOTB_F +! H5S_SELECT_NOTA_F +! H5S_SELECT_APPEND_F +! H5S_SELECT_PREPEND_F +! start - array with hyperslab offsets +! count - number of blocks included in the +! hyperslab +! OUTPUTS +! hyper_id - identifier for the new hyperslab +! hdferr: - error code +! Success: 0 +! Failure: -1 +! OPTIONAL PARAMETERS +! stride - array with hyperslab strides +! block - array with hyperslab block sizes +! +! AUTHOR +! Elena Pourmal +! October 7, 2002 +! +! HISTORY +! +! +! NOTES +! Commented out until 1.6 ? 10/08/2002 +! +! SOURCE ! SUBROUTINE h5scombine_hyperslab_f(space_id, operator, start, count, & ! hyper_id, hdferr, stride, block) ! IMPLICIT NONE - - ! H5S_SELECT_AND_F - ! H5S_SELECT_XOR_F - ! H5S_SELECT_NOTB_F - ! H5S_SELECT_NOTA_F - ! H5S_SELECT_APPEND_F - ! H5S_SELECT_PREPEND_F + ! H5S_SELECT_AND_F + ! H5S_SELECT_XOR_F + ! H5S_SELECT_NOTB_F + ! H5S_SELECT_NOTA_F + ! H5S_SELECT_APPEND_F + ! H5S_SELECT_PREPEND_F ! ! INTEGER :: rank @@ -1019,49 +1016,46 @@ CONTAINS ! END SUBROUTINE h5scombine_hyperslab_f -! !$! -!> -!! !$! -!! !$! NAME -!! !$! h5scombine_select_f -!! !$! -!! !$! PURPOSE -!! !$! Combine two hyperslab selections with an operation -!! !$! and return a dataspace with resulting selection. -!! !$! -!! !$! INPUTS -!! !$! space1_id - dataspace of selection to use -!! !$! operator - flag, valid values are: -!! !$! H5S_SELECT_NOOP_F -!! !$! H5S_SELECT_SET_F -!! !$! H5S_SELECT_OR_F -!! !$! H5S_SELECT_AND_F -!! !$! H5S_SELECT_XOR_F -!! !$! H5S_SELECT_NOTB_F -!! !$! H5S_SELECT_NOTA_F -!! !$! H5S_SELECT_APPEND_F -!! !$! H5S_SELECT_PREPEND_F -!! !$! space2_id - dataspace of selection to use -!! !$! OUTPUTS -!! !$! ds_id - idataspace identifier with the new selection -!! !$! hdferr: - error code -!! !$! Success: 0 -!! !$! Failure: -1 -!! !$! OPTIONAL PARAMETERS - NONE -!! !$! -!! !$! AUTHOR -!! !$! Elena Pourmal -!! !$! October 7, 2002 -!! !$! -!! !$! HISTORY -!! !$! -!! !$! -!! !$! NOTES commented out until 1.6 release(?) 10/08/2002 -!! !$! ! -!! ! SOURCE -! !$ SUBROUTINE h5scombine_select_f(space1_id, operator, space2_id, & -! ds_id, hdferr) +! NAME +! h5scombine_select_f +! +! PURPOSE +! Combine two hyperslab selections with an operation +! and return a dataspace with resulting selection. +! +! INPUTS +! space1_id - dataspace of selection to use +! operator - flag, valid values are: +! H5S_SELECT_NOOP_F +! H5S_SELECT_SET_F +! H5S_SELECT_OR_F +! H5S_SELECT_AND_F +! H5S_SELECT_XOR_F +! H5S_SELECT_NOTB_F +! H5S_SELECT_NOTA_F +! H5S_SELECT_APPEND_F +! H5S_SELECT_PREPEND_F +! space2_id - dataspace of selection to use +! OUTPUTS +! ds_id - idataspace identifier with the new selection +! hdferr: - error code +! Success: 0 +! Failure: -1 +! OPTIONAL PARAMETERS - NONE +! +! AUTHOR +! Elena Pourmal +! October 7, 2002 +! +! HISTORY +! +! +! NOTES commented out until 1.6 release(?) 10/08/2002 +! +! +! SOURCE +! SUBROUTINE h5scombine_select_f(space1_id, operator, space2_id, s_id, hdferr) ! IMPLICIT NONE ! H5S_SELECT_AND_F @@ -1085,47 +1079,45 @@ CONTAINS ! END SUBROUTINE h5scombine_select_f -! !$! -!> -!! !$! -!! !$! NAME -!! !$! h5smodify_select_f -!! !$! -!! !$! PURPOSE -!! !$! Refine a hyperslab selection with an operation -!! !$! using second hyperslab -!! !$! -!! !$! INPUTS -!! !$! space1_id - dataspace of selection to modify -!! !$! operator - flag, valid values are: -!! !$! H5S_SELECT_NOOP_F -!! !$! H5S_SELECT_SET_F -!! !$! H5S_SELECT_OR_F -!! !$! H5S_SELECT_AND_F -!! !$! H5S_SELECT_XOR_F -!! !$! H5S_SELECT_NOTB_F -!! !$! H5S_SELECT_NOTA_F -!! !$! H5S_SELECT_APPEND_F -!! !$! H5S_SELECT_PREPEND_F -!! !$! space2_id - dataspace of selection to use -!! !$! -!! !$! OUTPUTS -!! !$! hdferr: - error code -!! !$! Success: 0 -!! !$! Failure: -1 -!! !$! OPTIONAL PARAMETERS - NONE -!! !$! -!! !$! AUTHOR -!! !$! Elena Pourmal -!! !$! October 7, 2002 -!! !$! -!! !$! HISTORY -!! !$! -!! !$! -!! !$! NOTESCommented out until 1.6 release(?) 10/08/2002 EIP -!! !$! ! -!! ! SOURCE +! NAME +! h5smodify_select_f +! +! PURPOSE +! Refine a hyperslab selection with an operation +! using second hyperslab +! +! INPUTS +! space1_id - dataspace of selection to modify +! operator - flag, valid values are: +! H5S_SELECT_NOOP_F +! H5S_SELECT_SET_F +! H5S_SELECT_OR_F +! H5S_SELECT_AND_F +! H5S_SELECT_XOR_F +! H5S_SELECT_NOTB_F +! H5S_SELECT_NOTA_F +! H5S_SELECT_APPEND_F +! H5S_SELECT_PREPEND_F +! space2_id - dataspace of selection to use +! +! OUTPUTS +! hdferr: - error code +! Success: 0 +! Failure: -1 +! OPTIONAL PARAMETERS - NONE +! +! AUTHOR +! Elena Pourmal +! October 7, 2002 +! +! HISTORY +! +! +! NOTESCommented out until 1.6 release(?) 10/08/2002 EIP +! +! +! SOURCE ! SUBROUTINE h5smodify_select_f(space1_id, operator, space2_id, & ! hdferr) ! IMPLICIT NONE @@ -1136,7 +1128,7 @@ CONTAINS ! H5S_SELECT_NOTA_F ! H5S_SELECT_APPEND_F ! H5S_SELECT_PREPEND_F - ! + ! ! space2_id) diff --git a/fortran/src/H5Tff.F90 b/fortran/src/H5Tff.F90 index 9ee0ee8..36a35be 100644 --- a/fortran/src/H5Tff.F90 +++ b/fortran/src/H5Tff.F90 @@ -1089,7 +1089,7 @@ CONTAINS !! \param namelen Name length. !! \param hdferr \fortran_error !! -!! See C API: @ref char *H5Tget_member_name(hid_t type_id, unsigned membno); +!! See C API: @ref char* H5Tget_member_name(hid_t type_id, unsigned membno); !! SUBROUTINE h5tget_member_name_f(type_id, index, member_name, namelen, hdferr) IMPLICIT NONE @@ -1179,40 +1179,6 @@ CONTAINS hdferr = h5tget_member_index_c(type_id, name, namelen, index) END SUBROUTINE h5tget_member_index_f - -! !$! -!> -!! !$! -!! !$! NAME -!! !$! h5tget_member_dim_f -!! !$! -!! !$! PURPOSE -!! !$! This function is not supported in hdf5-1.4.* -!! !$! -!! !$! INPUTS -!! !$! OUTPUTS -!! !$! hdferr: - error code -!! !$! Success: 0 -!! !$! Failure: -1 -!! !$! -!! !$! AUTHOR -!! !$! Elena Pourmal -!! !$! August 12, 1999 -!! !$! -!! !$! HISTORY -!! !$! Explicit Fortran interfaces were added for -!! !$! called C functions (it is needed for Windows -!! !$! port). March 7, 2001 -!! !$! -!! !$! SOURCE -! !$! SUBROUTINE h5tget_member_dims_f(type_id, field_idx,dims, field_dims, perm, hdferr) -! !$! -! !$! IMPLICIT NONE - -! !$! -! !$! END SUBROUTINE h5tget_member_dims_f - - !> !! \ingroup FH5T !! @@ -1431,33 +1397,31 @@ CONTAINS hdferr = h5tpack_c(type_id) END SUBROUTINE h5tpack_f -! !$! -!> -!! !$! -!! !$! NAME -!! !$! h5tinsert_array_f -!! !$! -!! !$! PURPOSE -!! !$! This function is not available on hdf5-1.4.* -!! !$! -!! !$! INPUTS -!! !$! OUTPUTS -!! !$! hdferr: - error code -!! !$! Success: 0 -!! !$! Failure: -1 -!! !$! -!! !$! AUTHOR -!! !$! Elena Pourmal -!! !$! August 12, 1999 -!! !$! -!! !$! HISTORY -!! !$! Explicit Fortran interfaces were added for -!! !$! called C functions (it is needed for Windows -!! !$! port). March 7, 2001 -!! !$! SOURCE +! +! NAME +! h5tinsert_array_f +! +! PURPOSE +! This function is not available on hdf5-1.4.* +! +! INPUTS +! OUTPUTS +! hdferr: - error code +! Success: 0 +! Failure: -1 +! +! AUTHOR +! Elena Pourmal +! August 12, 1999 +! +! HISTORY +! Explicit Fortran interfaces were added for +! called C functions (it is needed for Windows +! port). March 7, 2001 +! SOURCE ! SUBROUTINE h5tinsert_array_f(parent_id,name,offset, ndims, dims, member_id, hdferr, perm) ! IMPLICIT NONE - +! ! INTEGER, EXTERNAL :: h5tinsert_array_c, h5tinsert_array_c2 ! namelen = LEN(name) ! if (present(perm)) then @@ -1679,7 +1643,7 @@ CONTAINS !! \param taglen Length of tag. !! \param hdferr \fortran_error !! -!! See C API: @ref char *H5Tget_tag(hid_t type); +!! See C API: @ref char* H5Tget_tag(hid_t type); !! SUBROUTINE h5tget_tag_f(type_id, tag,taglen, hdferr) IMPLICIT NONE @@ -1998,6 +1962,8 @@ CONTAINS !! \param flag .TRUE. for compiler conversion, .FALSE. for library conversion. !! \param hdferr \fortran_error !! +!! See C API: @ref htri_t H5Tcompiler_conv(hid_t src_id, hid_t dst_id); +!! SUBROUTINE h5tcompiler_conv_f(src_id, dst_id, flag, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: src_id diff --git a/fortran/src/H5VLff.F90 b/fortran/src/H5VLff.F90 index 1a4edf3..237e30d 100644 --- a/fortran/src/H5VLff.F90 +++ b/fortran/src/H5VLff.F90 @@ -49,7 +49,7 @@ CONTAINS ! H5VLregister_connector !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Registers a new VOL connector as a member of the virtual object layer class by name. !! @@ -90,7 +90,7 @@ CONTAINS END SUBROUTINE H5VLregister_connector_by_name_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Registers a new VOL connector by value. !! @@ -130,7 +130,7 @@ CONTAINS END SUBROUTINE H5VLregister_connector_by_value_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Determines whether a VOL class has been registered or not ccording to a specified connector name. !! @@ -167,7 +167,7 @@ CONTAINS END SUBROUTINE H5VLis_connector_registered_by_name_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Determines whether a VOL class has been registered or not according to a specified connector value (ID). !! @@ -201,7 +201,7 @@ CONTAINS END SUBROUTINE H5VLis_connector_registered_by_value_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Retrieves the ID for a registered VOL connector. !! @@ -234,7 +234,7 @@ CONTAINS END SUBROUTINE H5VLget_connector_id_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Retrieves the ID for a registered VOL connector. !! @@ -271,7 +271,7 @@ CONTAINS END SUBROUTINE H5VLget_connector_id_by_name_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Retrieves the ID for a registered VOL connector. !! @@ -304,7 +304,7 @@ CONTAINS END SUBROUTINE H5VLget_connector_id_by_value_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Retrieves a connector name for a VOL. !! @@ -351,7 +351,7 @@ CONTAINS END SUBROUTINE H5VLget_connector_name_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Closes a VOL connector ID. !! @@ -377,7 +377,7 @@ CONTAINS END SUBROUTINE H5VLclose_f !> -!! \ingroup FH5V +!! \ingroup FH5VL !! !! \brief Removes a VOL connector ID from the library. !! diff --git a/fortran/src/H5Zff.F90 b/fortran/src/H5Zff.F90 index d27c87b..42b3841 100644 --- a/fortran/src/H5Zff.F90 +++ b/fortran/src/H5Zff.F90 @@ -56,6 +56,8 @@ CONTAINS !! \li H5Z_FILTER_FLETCHER32_F !! \param hdferr \fortran_error !! +!! See C API: @ref herr_t H5Zunregister(H5Z_filter_t id); +!! SUBROUTINE h5zunregister_f(filter, hdferr) IMPLICIT NONE INTEGER, INTENT(IN) :: filter diff --git a/fortran/src/H5f90proto.h b/fortran/src/H5f90proto.h index 4aa33f6..0b348b7 100644 --- a/fortran/src/H5f90proto.h +++ b/fortran/src/H5f90proto.h @@ -305,8 +305,6 @@ H5_FCDLL int_f h5tget_strpad_c(hid_t_f *type_id, int_f *strpad); H5_FCDLL int_f h5tset_strpad_c(hid_t_f *type_id, int_f *strpad); H5_FCDLL int_f h5tget_nmembers_c(hid_t_f *type_id, int_f *num_members); H5_FCDLL int_f h5tget_member_name_c(hid_t_f *type_id, int_f *idx, _fcd member_name, int_f *namelen); -H5_FCDLL int_f h5tget_member_dims_c(hid_t_f *type_id, int_f *field_idx, int_f *dims, size_t_f *field_dims, - int_f *perm); H5_FCDLL int_f h5tget_member_offset_c(hid_t_f *type_id, int_f *member_no, size_t_f *offset); H5_FCDLL int_f h5tget_member_type_c(hid_t_f *type_id, int_f *field_idx, hid_t_f *datatype); H5_FCDLL int_f h5tget_member_index_c(hid_t_f *type_id, _fcd name, int_f *namelen, int_f *idx); diff --git a/hl/fortran/src/H5DSff.F90 b/hl/fortran/src/H5DSff.F90 index dcc6ed0..73d62b1 100644 --- a/hl/fortran/src/H5DSff.F90 +++ b/hl/fortran/src/H5DSff.F90 @@ -50,6 +50,8 @@ CONTAINS !! \param errcode \fortran_error !! \param dimname The dimension name !! +!! See C API: @ref herr_t H5DSset_scale(hid_t dsid, const char *dimname); +!! SUBROUTINE H5DSset_scale_f( dsid, errcode, dimname) IMPLICIT NONE @@ -91,6 +93,8 @@ CONTAINS !! \param idx The dimension of \p did that \p dsid is associated with. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5DSattach_scale(hid_t did, hid_t dsid, unsigned int idx); +!! SUBROUTINE H5DSattach_scale_f( did, dsid, idx, errcode) IMPLICIT NONE @@ -129,6 +133,8 @@ CONTAINS !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5DSdetach_scale(hid_t did, hid_t dsid, unsigned int idx); +!! SUBROUTINE H5DSdetach_scale_f( did, dsid, idx, errcode) IMPLICIT NONE @@ -167,6 +173,8 @@ CONTAINS !! \param is_attached If dimension scale \p dsid is currently attached to dimension \p idx of dataset \p did. !! \param errcode \fortran_error !! +!! See C API: @ref htri_t H5DSis_attached(hid_t did, hid_t dsid, unsigned int idx); +!! SUBROUTINE H5DSis_attached_f( did, dsid, idx, is_attached, errcode) IMPLICIT NONE @@ -216,6 +224,8 @@ CONTAINS !! \param is_scale If is a Dimension Scale. !! \param errcode \fortran_error !! +!! See C API: @ref htri_t H5DSis_scale(hid_t did); +!! SUBROUTINE H5DSis_scale_f( did, is_scale, errcode) IMPLICIT NONE @@ -256,6 +266,8 @@ CONTAINS !! \param label The label. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5DSset_label(hid_t did, unsigned int idx, const char *label); +!! SUBROUTINE H5DSset_label_f( did, idx, label, errcode) IMPLICIT NONE @@ -299,6 +311,8 @@ CONTAINS !! \param size The length of the \p label buffer. !! \param errcode \fortran_error !! +!! See C API: @ref ssize_t H5DSget_label(hid_t did, unsigned int idx, char *label, size_t size); +!! SUBROUTINE H5DSget_label_f( did, idx, label, size, errcode) IMPLICIT NONE @@ -339,6 +353,8 @@ CONTAINS !! \param size Size in bytes, of the name buffer. !! \param errcode \fortran_error !! +!! See C API: @ref ssize_t H5DSget_scale_name(hid_t did, char *name, size_t size); +!! SUBROUTINE H5DSget_scale_name_f(did, name, size, errcode) IMPLICIT NONE @@ -374,6 +390,8 @@ CONTAINS !! \param num_scales Number of Dimension Scales associated with \p did. !! \param errcode \fortran_error !! +!! See C API: @ref int H5DSget_num_scales(hid_t did, unsigned int idx); +!! SUBROUTINE H5DSget_num_scales_f( did, idx, num_scales, errcode) IMPLICIT NONE diff --git a/hl/fortran/src/H5IMff.F90 b/hl/fortran/src/H5IMff.F90 index 967c35d..d8d5366 100644 --- a/hl/fortran/src/H5IMff.F90 +++ b/hl/fortran/src/H5IMff.F90 @@ -51,6 +51,8 @@ CONTAINS !! \param buf Buffer with data to be written to the dataset !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMmake_image_8bit(hid_t loc_id, const char *dset_name, hsize_t width, hsize_t height, const unsigned char *buffer); +!! SUBROUTINE h5immake_image_8bit_f(loc_id,& dset_name,& width,& @@ -98,6 +100,8 @@ CONTAINS !! \param buf Buffer with data to store the image. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMread_image(hid_t loc_id, const char *dset_name, unsigned char *buffer); +!! SUBROUTINE h5imread_image_f(loc_id,& dset_name,& buf,& @@ -142,7 +146,9 @@ CONTAINS !! \param buf Buffer with data to be written to the dataset. !! \param errcode \fortran_error !! - SUBROUTINE h5immake_image_24bit_f(loc_id, dset_name, width, height, il, buf, errcode ) +!! See C API: @ref herr_t H5IMmake_image_24bit(hid_t loc_id, const char *dset_name, hsize_t width, hsize_t height, const char *interlace, const unsigned char *buffer); +!! + SUBROUTINE h5immake_image_24bit_f(loc_id, dset_name, width, height, il, buf, errcode) IMPLICIT NONE @@ -194,6 +200,8 @@ CONTAINS !! \param npals The number of palettes associated to the image. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMget_image_info(hid_t loc_id, const char *dset_name, hsize_t *width, hsize_t *height, hsize_t *planes, char *interlace, hssize_t *npals); +!! SUBROUTINE h5imget_image_info_f(loc_id,& dset_name,& width,& @@ -248,6 +256,8 @@ CONTAINS !! \param loc_id Location identifier. The identifier may be that of a file or group. !! \param dset_name The name of the dataset. !! +!! See C API: @ref herr_t H5IMis_image(hid_t loc_id, const char *dset_name); +!! INTEGER FUNCTION h5imis_image_f(loc_id, dset_name) IMPLICIT NONE @@ -286,6 +296,8 @@ CONTAINS !! \param pal_data Buffer with data to be written to the dataset. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMmake_palette(hid_t loc_id, const char *pal_name, const hsize_t *pal_dims, const unsigned char *pal_data); +!! SUBROUTINE h5immake_palette_f(loc_id,& pal_name,& pal_dims,& @@ -330,6 +342,8 @@ CONTAINS !! \param pal_name The name of the palette. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMlink_palette(hid_t loc_id, const char *image_name, const char *pal_name); +!! SUBROUTINE h5imlink_palette_f(loc_id,& image_name,& pal_name,& @@ -373,7 +387,9 @@ CONTAINS !! \param image_name The name of the image dataset. !! \param pal_name The name of the palette. !! \param errcode \fortran_error - +!! +!! See C API: @ref herr_t H5IMunlink_palette(hid_t loc_id, const char *image_name, const char *pal_name); +!! SUBROUTINE h5imunlink_palette_f(loc_id,& image_name,& pal_name,& @@ -418,6 +434,8 @@ CONTAINS !! \param npals The number of palettes. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMget_npalettes(hid_t loc_id, const char *image_name, hssize_t *npals); +!! SUBROUTINE h5imget_npalettes_f(loc_id,& image_name,& npals,& @@ -448,6 +466,7 @@ CONTAINS errcode = h5imget_npalettes_c(loc_id,namelen,image_name,npals) END SUBROUTINE h5imget_npalettes_f + !> !! \ingroup FH5IM !! @@ -459,6 +478,8 @@ CONTAINS !! \param pal_dims The dimensions of the palette dataset. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMget_palette_info(hid_t loc_id, const char *image_name, int pal_number, hsize_t *pal_dims); +!! SUBROUTINE h5imget_palette_info_f(loc_id,& image_name,& pal_number,& @@ -504,6 +525,8 @@ CONTAINS !! \param pal_data The palette dataset. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5IMget_palette_info(hid_t loc_id, const char *image_name, int pal_number, hsize_t *pal_dims); +!! SUBROUTINE h5imget_palette_f(loc_id,& image_name,& pal_number,& @@ -546,6 +569,8 @@ CONTAINS !! \param loc_id Location identifier. The identifier may be that of a file or group. !! \param dset_name The name of the dataset. !! +!! See C API: @ref herr_t H5IMis_palette(hid_t loc_id, const char *dset_name); +!! INTEGER FUNCTION h5imis_palette_f(loc_id, dset_name) IMPLICIT NONE diff --git a/hl/fortran/src/H5LTff.F90 b/hl/fortran/src/H5LTff.F90 index 3b50ad8..2469dbb 100644 --- a/hl/fortran/src/H5LTff.F90 +++ b/hl/fortran/src/H5LTff.F90 @@ -146,6 +146,8 @@ CONTAINS !! \param buf Buffer with data to be written to the dataset. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, hid_t type_id, const void *buffer); + !! SUBROUTINE h5ltmake_dataset_f(& #else SUBROUTINE h5ltmake_dataset_f_ptr( & @@ -193,6 +195,8 @@ CONTAINS !! \param buf Buffer with data to be written to the dataset. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTmake_dataset(hid_t loc_id, const char *dset_name, int rank, const hsize_t *dims, hid_t type_id, const void *buffer); + !! SUBROUTINE h5ltmake_dataset_f(& #else SUBROUTINE h5ltmake_dataset_f_int1(& @@ -385,6 +389,8 @@ CONTAINS !! \param buf Buffer with data to be written to the dataset. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTread_dataset(hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer); + !! SUBROUTINE h5ltread_dataset_f(& #else SUBROUTINE h5ltread_dataset_f_ptr(& @@ -426,6 +432,8 @@ CONTAINS !! \param dims An array of the size of each dimension. Limited to seven dimensions. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTread_dataset(hid_t loc_id, const char *dset_name, hid_t type_id, void *buffer); + !! SUBROUTINE h5ltread_dataset_f(& #else SUBROUTINE h5ltread_dataset_f_int1(& @@ -1109,6 +1117,8 @@ CONTAINS !! This value is used by H5Screate_simple() to create the dataspace. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTset_attribute_int(hid_t loc_id, const char *obj_name, const char *attr_name, const int *buffer, size_t size); + !! SUBROUTINE h5ltset_attribute_int_f(loc_id,& obj_name,& attr_name,& @@ -1158,6 +1168,8 @@ CONTAINS !! This value is used by H5Screate_simple() to create the dataspace. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTset_attribute_float(hid_t loc_id, const char *obj_name, const char *attr_name, const float *buffer, size_t size); + !! SUBROUTINE h5ltset_attribute_float_f(loc_id,& obj_name,& attr_name,& @@ -1206,6 +1218,8 @@ CONTAINS !! This value is used by H5Screate_simple() to create the dataspace. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTset_attribute_double(hid_t loc_id, const char *obj_name, const char *attr_name, const double *buffer, size_t size); + !! SUBROUTINE h5ltset_attribute_double_f(loc_id,& obj_name,& attr_name,& @@ -1253,6 +1267,8 @@ CONTAINS !! \param buf Buffer with data to be written to the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTset_attribute_string(hid_t loc_id, const char *obj_name, const char *attr_name, const char *attr_data); + !! SUBROUTINE h5ltset_attribute_string_f(loc_id,& obj_name,& attr_name,& @@ -1302,6 +1318,8 @@ CONTAINS !! \param SizeOf_buf_type Size of \p buf's data type, in bytes. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute(hid_t loc_id, const char *obj_name, const char *attr_name, hid_t mem_type_id, void *data); + !! SUBROUTINE h5ltget_attribute_f(loc_id,& obj_name,& attr_name,& @@ -1349,6 +1367,8 @@ CONTAINS !! \param buf Buffer with data to be written to the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_int(hid_t loc_id, const char *obj_name, const char *attr_name, int *data); + !! SUBROUTINE h5ltget_attribute_int_f(loc_id,& obj_name,& attr_name,& @@ -1392,6 +1412,8 @@ CONTAINS !! \param buf Buffer with data to be written to the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_float(hid_t loc_id, const char *obj_name, const char *attr_name, float *data); + !! SUBROUTINE h5ltget_attribute_float_f(loc_id,& obj_name,& attr_name,& @@ -1434,6 +1456,8 @@ CONTAINS !! \param buf Buffer with data to be written to the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_double(hid_t loc_id, const char *obj_name, const char *attr_name, double *data); + !! SUBROUTINE h5ltget_attribute_double_f(loc_id,& obj_name,& attr_name,& @@ -1477,6 +1501,8 @@ CONTAINS !! \param buf Buffer with data to be written to the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_string(hid_t loc_id, const char *obj_name, const char *attr_name, char *data); + !! SUBROUTINE h5ltget_attribute_string_f(loc_id,& obj_name,& attr_name,& @@ -1531,6 +1557,8 @@ CONTAINS !! \param rank The dimensionality of the dataset. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_dataset_ndims(hid_t loc_id, const char *dset_name, int *rank); + !! SUBROUTINE h5ltget_dataset_ndims_f(loc_id,& dset_name,& rank,& @@ -1571,8 +1599,9 @@ CONTAINS !! !! \result Returns zero (false), a positive (true) or a negative (failure) value. !! - INTEGER FUNCTION h5ltfind_dataset_f(loc_id,& - dset_name) + !! See C API: @ref herr_t H5LTfind_dataset(hid_t loc_id, const char *name); + !! + INTEGER FUNCTION h5ltfind_dataset_f(loc_id, dset_name) IMPLICIT NONE INTEGER(hid_t), INTENT(in) :: loc_id @@ -1610,6 +1639,8 @@ CONTAINS !! \param type_size The size of the datatype in bytes. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_dataset_info(hid_t loc_id, const char *dset_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size); + !! SUBROUTINE h5ltget_dataset_info_f(loc_id,& dset_name,& dims,& @@ -1662,6 +1693,8 @@ CONTAINS !! \param rank The dimensionality of the attribute. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_ndims(hid_t loc_id, const char *obj_name, const char *attr_name, int *rank); + !! SUBROUTINE h5ltget_attribute_ndims_f(loc_id,& obj_name,& attr_name,& @@ -1711,6 +1744,8 @@ CONTAINS !! \param type_size The size of the datatype in bytes. !! \param errcode \fortran_error !! + !! See C API: @ref herr_t H5LTget_attribute_info(hid_t loc_id, const char *obj_name, const char *attr_name, hsize_t *dims, H5T_class_t *type_class, size_t *type_size); + !! SUBROUTINE h5ltget_attribute_info_f(loc_id,& obj_name,& attr_name,& @@ -1764,6 +1799,8 @@ CONTAINS !! \param path_valid Object status. !! \param errcode \fortran_error !! + !! See C API: @ref htri_t H5LTpath_valid(hid_t loc_id, const char *path, hbool_t check_object_valid); + !! SUBROUTINE h5ltpath_valid_f(loc_id, path, check_object_valid, path_valid, errcode) IMPLICIT NONE diff --git a/hl/fortran/src/H5TBff.F90 b/hl/fortran/src/H5TBff.F90 index 52af33f..9985ab8 100644 --- a/hl/fortran/src/H5TBff.F90 +++ b/hl/fortran/src/H5TBff.F90 @@ -216,6 +216,8 @@ CONTAINS !! \param compress Flag that turns compression on or off. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBmake_table(const char *table_title, hid_t loc_id, const char *dset_name, hsize_t nfields, hsize_t nrecords, size_t type_size, const char *field_names[], const size_t *field_offset, const hid_t *field_types, hsize_t chunk_size, void *fill_data, int compress, const void *buf); +!! #ifdef H5_DOXYGEN_FORTRAN SUBROUTINE h5tbmake_table_f(& #else @@ -333,6 +335,8 @@ CONTAINS !! \param data Buffer with data to be written to the table !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBmake_table(const char *table_title, hid_t loc_id, const char *dset_name, hsize_t nfields, hsize_t nrecords, size_t type_size, const char *field_names[], const size_t *field_offset, const hid_t *field_types, hsize_t chunk_size, void *fill_data, int compress, const void *buf); +!! #ifdef H5_DOXYGEN_FORTRAN SUBROUTINE h5tbmake_table_f(& #else @@ -450,6 +454,8 @@ CONTAINS !! \param dst_buf Pointer to buffer with data. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBread_table(hid_t loc_id, const char *dset_name, size_t dst_size, const size_t *dst_offset, const size_t *dst_sizes, void *dst_buf); +!! SUBROUTINE h5tbread_table_f(loc_id, dset_name, nfields, dst_size, dst_offset, & dst_sizes, dst_buf, errcode) @@ -519,6 +525,8 @@ CONTAINS !! \param buf Buffer with data. !! \param errcode \fortran_error !! +!! See similar C API: @ref herr_t H5TBwrite_fields_name(hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf); +!! SUBROUTINE h5tbwrite_field_name_f(& #else SUBROUTINE h5tbwrite_field_name_f_int(& @@ -609,6 +617,8 @@ CONTAINS !! \param buf Buffer with data !! \param errcode \fortran_error !! +!! See similar C API: @ref herr_t H5TBread_fields_name(hid_t loc_id, const char *dset_name, const char *field_names, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, void *buf); +!! SUBROUTINE h5tbread_field_name_f(& #else SUBROUTINE h5tbread_field_name_f_int(& @@ -701,6 +711,8 @@ CONTAINS !! \param buf Buffer with data. !! \param errcode \fortran_error !! +!! See similar C API: herr_t H5TBwrite_fields_index(hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes, const void *buf); +!! SUBROUTINE h5tbwrite_field_index_f(& #else SUBROUTINE h5tbwrite_field_index_f_int(& @@ -787,6 +799,8 @@ CONTAINS !! \param buf Buffer with data. !! \param errcode \fortran_error !! +!! See similar C API: herr_t H5TBread_fields_index(hid_t loc_id, const char *dset_name, hsize_t nfields, const int *field_index, hsize_t start, hsize_t nrecords, size_t type_size, const size_t *field_offset, const size_t *dst_sizes,void *buf); +!! SUBROUTINE h5tbread_field_index_f(& #else SUBROUTINE h5tbread_field_index_f_int(& @@ -870,6 +884,8 @@ CONTAINS !! \param buf Buffer with data. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBinsert_field(hid_t loc_id, const char *dset_name, const char *field_name, hid_t field_type, hsize_t position, const void *fill_data, const void *buf); +!! SUBROUTINE h5tbinsert_field_f(& #else SUBROUTINE h5tbinsert_field_f_int(& @@ -952,6 +968,8 @@ CONTAINS !! \param field_name The name of the field to delete. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBdelete_field(hid_t loc_id, const char *dset_name, const char *field_name); +!! SUBROUTINE h5tbdelete_field_f(loc_id,& dset_name,& field_name,& @@ -997,6 +1015,8 @@ CONTAINS !! \param nrecords The number of records. !! \param errcode \fortran_error !! +!! See C API: @ref herr_t H5TBget_table_info(hid_t loc_id, const char *dset_name, hsize_t *nfields, hsize_t *nrecords); +!! SUBROUTINE h5tbget_table_info_f(loc_id,& dset_name,& nfields,& @@ -1046,6 +1066,8 @@ CONTAINS !! \param errcode \fortran_error !! \param maxlen_out Maximum character length of the field names. !! +!! See C API: @ref herr_t H5TBget_field_info(hid_t loc_id, const char *dset_name, char *field_names[], size_t *field_sizes, size_t *field_offsets, size_t *type_size); +!! SUBROUTINE h5tbget_field_info_f(loc_id,& dset_name,& nfields,& -- cgit v0.12