From 877e4a67c5440f801e9faccf4ca1a451c89eae59 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Wed, 1 Mar 2023 08:07:37 -0600 Subject: Missing or misplaced entries in API reference tables #2470 (#2472) * Missing or misplaced entries in API reference tables #2470 * Doxy corrections --- doxygen/dox/Overview.dox | 4 - doxygen/examples/tables/propertyLists.dox | 267 +++++++++++++++++++++++------- src/H5Pmodule.h | 2 + 3 files changed, 208 insertions(+), 65 deletions(-) diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox index 3d171f7..fb6231c 100644 --- a/doxygen/dox/Overview.dox +++ b/doxygen/dox/Overview.dox @@ -37,10 +37,6 @@ documents cover a mix of tasks, concepts, and reference, to help a specific \par Offline reading You can download it as a tgz archive for offline reading. -\par History - A snapshot (~April 2017) of the pre-Doxygen HDF5 documentation can be found - here. - \par ToDo List There is plenty of unfinished business. diff --git a/doxygen/examples/tables/propertyLists.dox b/doxygen/examples/tables/propertyLists.dox index 498a820..375fd50 100644 --- a/doxygen/examples/tables/propertyLists.dox +++ b/doxygen/examples/tables/propertyLists.dox @@ -86,7 +86,7 @@ Iterates over properties in a property class or list -#H5Pregister/H5Punregister +#H5Pregister/#H5Punregister Registers/removes a permanent property with/from a property list class @@ -124,14 +124,6 @@ Sets/retrieves size of parameter used to control B-trees for indexing chunked datasets. -#H5Pset_file_image -Sets an initial file image in a memory buffer. - - -#H5Pget_file_image -Retrieves a copy of the file image designated as the initial content and structure of a file. - - #H5Pset_file_space_page_size/#H5Pget_file_space_page_size Sets or retrieves the file space page size used in paged aggregation and paged buffering. @@ -179,11 +171,19 @@ creation property list. Sets/retrieves metadata cache and raw data chunk cache parameters. +#H5Pset_core_write_tracking/#H5Pget_core_write_tracking +Sets/retrieves write tracking information for core driver. + + #H5Pset_elink_file_cache_size/#H5Pget_elink_file_cache_size Sets/retrieves the size of the external link open file cache from the specified file access property list. +#H5Pset_evict_on_close/#H5Pget_evict_on_close +Set/get the file access property list setting that determines whether an HDF5 object will be evicted from the library's metadata cache when it is closed. + + #H5Pset_gc_references/#H5Pget_gc_references Sets/retrieves garbage collecting references flag. @@ -196,18 +196,56 @@ file access property list. Retrieves a data offset from the file access property list. +#H5Pset_fclose_degree/#H5Pget_fclose_degree +Sets/retrieves file close degree property. + + +#H5Pset_file_image +Sets an initial file image in a memory buffer. + + +#H5Pget_file_image +Retrieves a copy of the file image designated as the initial content and structure of a file. + + +#H5Pset_file_image_callbacks/#H5Pget_file_image_callbacks +Sets/gets the callbacks for working with file images. + + +#H5Pset_file_locking/#H5Pget_file_locking +Sets/retrieves file locking property values. + + #H5Pset_meta_block_size/#H5Pget_meta_block_size Sets the minimum metadata blocksize or retrieves the current metadata block size setting. -#H5Pset_mdc_config -Set the initial metadata cache configuration in the indicated File Access Property List -to the supplied value. +#H5Pset_metadata_read_attempts/#H5Pget_metadata_read_attempts +Sets/gets the number of read attempts from a file access property list. + + +#H5Pset_mdc_config/#H5Pget_mdc_config +Set/get the initial metadata cache configuration in the indicated file access property list. + + +#H5Pset_mdc_image_config/#H5Pget_mdc_image_config +Set/get the metadata cache image option for a file access property list. + + +#H5Pset_mdc_log_options/#H5Pget_mdc_log_options +Set/get the metadata cache logging options. + + +#H5Pset_multi_type/#H5Pget_multi_type +Sets/gets the type of data property for the MULTI driver. + + +#H5Pset_object_flush_cb/#H5Pget_object_flush_cb +Set/get the object flush property values from the file access property list. -#H5Pget_mdc_config -Get the current initial metadata cache config-uration from the indicated File Access -Property List. +#H5Pset_page_buffer_size/#H5Pget_page_buffer_size +Set/get the the maximum size for the page buffer. #H5Pset_sieve_buf_size/#H5Pget_sieve_buf_size @@ -231,6 +269,30 @@ versions used when creating objects. #H5Pget_small_data_block_size Retrieves the current small data block size setting. + +#H5Pset_vol +Sets the file VOL connector for a file access property list. + + +#H5Pget_vol_cap_flags +Retrieves the capability flags for the VOL connector that will be used with a file access property list. + + +#H5Pget_vol_id +Retrieves the identifier of the current VOL connector. + + +#H5Pget_vol_info +Retrieves a copy of the VOL information for a connector. + + +#H5Pset_mpi_params/#H5Pget_mpi_params +Sets/retrieves the MPI communicator and info. + + +#H5Pset_coll_metadata_write/#H5Pget_coll_metadata_write +Sets/retrieves metadata write mode setting. + //! [fapl_table] * @@ -254,6 +316,18 @@ versions used when creating objects. Returns a pointer to file driver information. +#H5Pset_driver_by_name +Sets a file driver according to a given driver name. + + +#H5Pset_driver_by_value +Sets a file driver according to a given driver value. + + +#H5Pget_driver_config_str +Retrieves a string representation of the configuration for the driver. + + #H5Pset_fapl_core/#H5Pget_fapl_core Sets the driver for buffered memory files (in RAM) or retrieves information regarding the driver. @@ -268,10 +342,22 @@ the driver. larger than 2 gigabytes, or retrieves information regarding driver. +#H5Pset_fapl_hdfs/#H5Pget_fapl_hdfs +. + + +#H5Pset_fapl_ioc/#H5Pget_fapl_ioc +Modifies/queries the file driver properties of the I/O concentrator driver. + + #H5Pset_fapl_log Sets logging driver. +#H5Pset_fapl_mirror/#H5Pget_fapl_mirror +Modifies/queries the file driver properties of the mirror driver. + + #H5Pset_fapl_mpio/#H5Pget_fapl_mpio Sets driver for files on parallel file systems (MPI I/O) or retrieves information regarding the driver. @@ -286,6 +372,10 @@ regarding the driver. or retrieves information regarding driver. +#H5Pset_fapl_onion/#H5Pget_fapl_onion +Modifies/queries the file driver properties of the onion driver. + + #H5Pset_fapl_sec2 Sets driver for unbuffered permanent files or retrieves information regarding driver. @@ -299,6 +389,10 @@ and one raw data file. Sets driver for buffered permanent files. +#H5Pset_fapl_subfiling/#H5Pget_fapl_subfiling +Modifies/queries the file driver properties of the subfiling driver. + + #H5Pset_fapl_windows Sets the Windows I/O driver. @@ -337,6 +431,10 @@ and one raw data file. Retrieves the size of chunks for the raw data of a chunked layout dataset. +#H5Pset_chunk_opts/#H5Pget_chunk_opts +Sets/gets the edge chunk option setting from a dataset creation property list. + + #H5Pset_deflate Sets compression method and compression level. @@ -439,6 +537,34 @@ encoding for object names. #H5Pget_char_encoding Retrieves the character encoding used to create a string. + +#H5Pset_virtual +Sets the mapping between virtual and source datasets. + + +#H5Pget_virtual_count +Gets the number of mappings for the virtual dataset. + + +#H5Pget_virtual_dsetname +Gets the name of a source dataset used in the mapping. + + +#H5Pget_virtual_filename +Gets the filename of a source dataset used in the mapping. + + +#H5Pget_virtual_srcspace +Gets a dataspace identifier for the selection within the source dataset used in the mapping. + + +#H5Pget_virtual_vspace +Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. + + +#H5Pset_dset_no_attrs_hint/#H5Pget_dset_no_attrs_hint +Sets/gets the flag to create minimized dataset object headers. + //! [dcpl_table] * @@ -458,32 +584,77 @@ encoding for object names. Reads buffer settings. +#H5Pset_append_flush/#H5Pget_append_flush +Sets/gets the values of the append property that is set up in the dataset access property list. + + #H5Pset_chunk_cache/#H5Pget_chunk_cache Sets/gets the raw data chunk cache parameters. -#H5Pset_edc_check/#H5Pget_edc_check -Sets/gets whether to enable error-detection when reading a dataset. +#H5Pset_efile_prefix/#H5Pget_efile_prefix +Sets/gets the prefix for external raw data storage files as set in the dataset access property list. -#H5Pset_filter_callback -Sets user-defined filter callback function. +#H5Pset_virtual_prefix/#H5Pget_virtual_prefix +Sets/gets the prefix to be applied to VDS source file paths. + + +#H5Pset_virtual_printf_gap/#H5Pget_virtual_printf_gap +Sets/gets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset. + + +#H5Pset_virtual_view/#H5Pget_virtual_view +Sets/gets the view of the virtual dataset (VDS) to include or exclude missing mapped elements. + + +//! [dapl_table] + * +//! [dxpl_table] + + + + + + + + + + + + + - - + + + + + + + + + + + + + + - - + + @@ -511,38 +682,20 @@ encoding for object names. - - - - - - - -
Data transfer property list functions (H5P)
C FunctionPurpose
#H5Pset_btree_ratios/#H5Pget_btree_ratiosSets/gets B-tree split ratios for a dataset transfer property list.
#H5Pset_bufferMaximum size for the type conversion buffer and the background buffer. May also supply +pointers to application-allocated buffers.
#H5Pset_data_transform/#H5Pget_data_transform Sets/gets a data transform expression.
#H5Pset_type_conv_cb/#H5Pget_type_conv_cbSets/gets user-defined datatype conversion callback function.#H5Pset_dataset_io_hyperslab_selectionSets a hyperslab file selection for a dataset I/O operation.
#H5Pset_edc_check/#H5Pget_edc_checkSets/gets whether to enable error-detection when reading a dataset.
#H5Pset_hyper_vector_sizeset the number of "I/O vectors" (offset and length pairs) which are to be +accumulated in memory before being issued to the lower levels +of the library for reading or writing the actual data.
#H5Pset_filter_callbackSets user-defined filter callback function.
#H5Pset_hyper_vector_size/#H5Pget_hyper_vector_size Sets/gets number of I/O vectors to be read/written in hyperslab I/O.
#H5Pset_btree_ratios/#H5Pget_btree_ratiosSets/gets B-tree split ratios for a dataset transfer property list.#H5Pset_type_conv_cb/#H5Pget_type_conv_cbSets/gets user-defined datatype conversion callback function.
#H5Pset_vlen_mem_manager/#H5Pget_vlen_mem_manager Sets a flag governing the use of independent versus collective I/O.
#H5Pset_multi_type/#H5Pget_multi_typeSets/gets the type of data property for the MULTI driver.
#H5Pset_small_data_block_size/#H5Pget_small_data_block_sizeSets/gets the size of a contiguous block reserved for small data.
-//! [dapl_table] - * -//! [dxpl_table] - - - - - + + - - + + - - + + - - + +
Data transfer property list functions (H5P)
C FunctionPurpose#H5Pget_mpio_actual_chunk_opt_modeGets the type of chunk optimization that HDF5 actually performed on the last parallel I/O call.
#H5Pset_bufferMaximum size for the type conversion buffer and the background buffer. May also supply -pointers to application-allocated buffers.#H5Pget_mpio_actual_io_modeGets the type of I/O that HDF5 actually performed on the last parallel I/O call.
#H5Pset_hyper_vector_sizeset the number of "I/O vectors" (offset and length pairs) which are to be -accumulated in memory before being issued to the lower levels -of the library for reading or writing the actual data.#H5Pget_mpio_no_collective_causeGets local and global causes that broke collective I/O on the last parallel I/O call.
#H5Pset_btree_ratiosSet the B-tree split ratios for a dataset transfer property list. The split ratios determine -what percent of children go in the first node when a node splits.H5Pset_preserve/H5Pget_preserveNo longer available, deprecated as it no longer has any effect.
//! [dxpl_table] @@ -593,6 +746,10 @@ C function is a macro: \see \ref api-compat-macros. Sets up use of the Fletcher32 checksum filter. +#H5Pset_local_heap_size_hint#H5Pget_local_heap_size_hint/ +Sets/gets the anticipated maximum size of a local heap. + + #H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups. @@ -625,14 +782,6 @@ C function is a macro: \see \ref api-compat-macros. Queries whether link creation order is tracked and/or indexed in a group. -#H5Pset_create_intermediate_group -Specifies in the property list whether to create missing intermediate groups. - - -#H5Pget_create_intermediate_group -Determines whether the property is set to enable creating missing intermediate groups. - - #H5Pset_char_encoding Sets the character encoding used to encode a string. Use to set ASCII or UTF-8 character encoding for object names. @@ -771,10 +920,6 @@ encoding for object names. #H5Pset_char_encoding/#H5Pget_char_encoding Sets/gets the character encoding used to encode link and attribute names. - -#H5Pset_create_intermediate_group/#H5Pget_create_intermediate_group -Specifies/retrieves whether to create missing intermediate groups. - //! [strcpl_table] * diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index 38d06e2..f2a1e5a 100644 --- a/src/H5Pmodule.h +++ b/src/H5Pmodule.h @@ -904,6 +904,7 @@ * * \ref PLCR * \snippet{doc} tables/propertyLists.dox fapl_table + * \snippet{doc} tables/propertyLists.dox fd_pl_table * * \ref PLCR * \snippet{doc} tables/propertyLists.dox lapl_table @@ -1007,6 +1008,7 @@ * can be adjusted at runtime before a file is created or opened. * * \snippet{doc} tables/propertyLists.dox fapl_table + * \snippet{doc} tables/propertyLists.dox fd_pl_table * * \defgroup FCPL File Creation Properties * \ingroup GCPL -- cgit v0.12