From a9d8b469f46d2f5de7521b986d2e14725e081eb9 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Fri, 16 Sep 2022 12:45:06 -0500 Subject: Use doxygen snippets for common tables (#2104) --- doxygen/examples/tables/fileDriverLists.dox | 139 +++++ doxygen/examples/tables/propertyLists.dox | 810 ++++++++++++++++++++++++++++ src/H5Dmodule.h | 307 +---------- src/H5Fmodule.h | 298 +--------- src/H5Gmodule.h | 95 +--- src/H5Pmodule.h | 153 ++++-- src/H5Ppublic.h | 10 +- 7 files changed, 1069 insertions(+), 743 deletions(-) create mode 100644 doxygen/examples/tables/fileDriverLists.dox create mode 100644 doxygen/examples/tables/propertyLists.dox diff --git a/doxygen/examples/tables/fileDriverLists.dox b/doxygen/examples/tables/fileDriverLists.dox new file mode 100644 index 0000000..1aae3ce --- /dev/null +++ b/doxygen/examples/tables/fileDriverLists.dox @@ -0,0 +1,139 @@ +/** File Driver List + * +//! [file_driver_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
I/O file drivers
File DriverDescription
#H5FD_COREStore in memory (optional backing store to disk file).
#H5FD_FAMILYStore in a set of files.
#H5FD_LOGStore in logging file.
#H5FD_MPIOStore using MPI/IO.
#H5FD_MULTIStore in multiple files. There are several options to control layout.
#H5FD_SEC2Serial I/O to file using Unix “section 2” functions.
#H5FD_STDIOSerial I/O to file using Unix “stdio” functions.
+//! [file_driver_table] + * + * +//! [supported_file_driver_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported file drivers
Driver NameDriver IdentifierDescriptionRelated API
POSIX#H5FD_SEC2This driver uses POSIX file-system functions like read and write to perform I/O to a single, +permanent file on local disk with no system buffering. This driver is POSIX-compliant and is +the default file driver for all systems.#H5Pset_fapl_sec2
Direct#H5FD_DIRECTThis is the #H5FD_SEC2 driver except data is written to or read from the file +synchronously without being cached by the system.#H5Pset_fapl_direct
Log#H5FD_LOGThis is the #H5FD_SEC2 driver with logging capabilities.#H5Pset_fapl_log
Windows#H5FD_WINDOWSThis driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, +#H5FD_SEC2. This change should not affect user applications.#H5Pset_fapl_windows
STDIO#H5FD_STDIOThis driver uses functions from the standard C stdio.h to perform I/O +to a single, permanent file on local disk with additional system buffering.#H5Pset_fapl_stdio
Memory#H5FD_COREWith this driver, an application can work with a file in memory for faster reads and +writes. File contents are kept in memory until the file is closed. At closing, the memory +version of the file can be written back to disk or abandoned.#H5Pset_fapl_core
Family#H5FD_FAMILYWith this driver, the HDF5 file’s address space is partitioned into pieces and sent to +separate storage files using an underlying driver of the user’s choice. This driver is for +systems that do not support files larger than 2 gigabytes.#H5Pset_fapl_family
Multi#H5FD_MULTIWith this driver, data can be stored in multiple files according to the type of the data. +I/O might work better if data is stored in separate files based on the type of data. The Split +driver is a special case of this driver.#H5Pset_fapl_multi
SplitH5FD_SPLITThis file driver splits a file into two parts. One part stores metadata, and the other part +stores raw data. This splitting a file into two parts is a limited case of the Multi driver.#H5Pset_fapl_split
Parallel#H5FD_MPIOThis is the standard HDF5 file driver for parallel file systems. This driver uses the MPI +standard for both communication and file I/O.#H5Pset_fapl_mpio
Parallel POSIXH5FD_MPIPOSIXThis driver is no longer available
StreamH5FD_STREAMThis driver is no longer available.
+//! [supported_file_driver_table] + * + */ diff --git a/doxygen/examples/tables/propertyLists.dox b/doxygen/examples/tables/propertyLists.dox new file mode 100644 index 0000000..498a820 --- /dev/null +++ b/doxygen/examples/tables/propertyLists.dox @@ -0,0 +1,810 @@ +/** Property List Tables + * +//! [plcr_table] + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property list class root functions (H5P)
FunctionPurpose
#H5PcloseTerminates access to a property list.
#H5PcopyCopies an existing property list to create a new property list.
#H5PcreateCreates a new property list as an instance of a property list class.
#H5Pencode/#H5PdecodeEncodes/ecodes property list into/from a binary object buffer.
#H5Pget_classReturns the property list class identifier for a property list
+//! [plcr_table] + * +//! [plcra_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property list class root (Advanced) functions (H5P)
FunctionPurpose
#H5Pclose_classCloses an existing property list class.
#H5Pcopy_propCopies a property from one list or class to another.
#H5Pcreate_classCreates a new property list class.
#H5PequalCompares two property lists or classes for equality.
#H5PexistQueries whether a property name exists in a property list or class.
#H5Pget_class_nameRetrieves the name of a class.
#H5Pget_class_parentRetrieves the parent class of a property class.
#H5Pget_npropsQueries the number of properties in a property list or class.
#H5Pget_sizeQueries the size of a property value in bytes.
#H5PinsertRegisters a temporary property with a property list.
#H5Pisa_classDetermines whether a property list is a member of a class.
#H5PiterateIterates over properties in a property class or list
#H5Pregister/H5PunregisterRegisters/removes a permanent property with/from a property list class
#H5PremoveRemoves a property from a property list.
#H5Pset/#H5PgetSets/queries a property list value
+//! [plcra_table] + * +//! [fcpl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
File creation property list functions (H5P)
FunctionPurpose
#H5Pset_userblock/#H5Pget_userblockSets/retrieves size of userblock.
#H5Pset_sizes/#H5Pget_sizesSets/retrieves byte size of offsets and lengths used to address objects in HDF5 file.
#H5Pset_sym_k/#H5Pget_sym_kSets/retrieves size of parameters used to control symbol table nodes.
#H5Pset_istore_k/#H5Pget_istore_kSets/retrieves size of parameter used to control B-trees for indexing chunked datasets.
#H5Pset_file_imageSets an initial file image in a memory buffer.
#H5Pget_file_imageRetrieves 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_sizeSets or retrieves the file space page size used in paged aggregation and paged buffering.
#H5Pset_file_space_strategy/#H5Pget_file_space_strategySets or retrieves the file space handling strategy, the persisting free-space and the free-space section size.
#H5Pset_shared_mesg_nindexes/#H5Pget_shared_mesg_nindexesSets or retrieves number of shared object header message indexes in file +creation property list.
#H5Pset_shared_mesg_indexConfigures the specified shared object header message index.
#H5Pget_shared_mesg_indexRetrieves the configuration settings for a shared message index.
#H5Pset_shared_mesg_phase_change/#H5Pget_shared_mesg_phase_changeSets or retrieves shared object header message storage phase change thresholds.
#H5Pget_version
+//! [fcpl_table] + * +//! [fapl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
File access property list functions (H5P)
FunctionPurpose
#H5Pset_alignment/#H5Pget_alignmentSets/retrieves alignment properties.
#H5Pset_cache/#H5Pget_cacheSets/retrieves metadata cache and raw data chunk cache parameters.
#H5Pset_elink_file_cache_size/#H5Pget_elink_file_cache_sizeSets/retrieves the size of the external link open file cache from the specified +file access property list.
#H5Pset_gc_references/#H5Pget_gc_referencesSets/retrieves garbage collecting references flag.
#H5Pset_family_offsetSets offset property for low-level access to a file in a family of files.
#H5Pget_family_offsetRetrieves a data offset from the file access property list.
#H5Pset_meta_block_size/#H5Pget_meta_block_sizeSets the minimum metadata blocksize or retrieves the current metadata block size setting.
#H5Pset_mdc_configSet the initial metadata cache configuration in the indicated File Access Property List +to the supplied value.
#H5Pget_mdc_configGet the current initial metadata cache config-uration from the indicated File Access +Property List.
#H5Pset_sieve_buf_size/#H5Pget_sieve_buf_sizeSets/retrieves maximum size of data sieve buffer.
#H5Pset_libver_boundsSets bounds on library versions, and indirectly format versions, to be used +when creating objects.
#H5Pget_libver_boundsRetrieves library version bounds settings that indirectly control the format +versions used when creating objects.
#H5Pset_small_data_block_sizeSets the size of a contiguous block reserved for small data.
#H5Pget_small_data_block_sizeRetrieves the current small data block size setting.
+//! [fapl_table] + * +//! [fd_pl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
File driver property list functions (H5P)
FunctionPurpose
#H5Pset_driverSets a file driver.
#H5Pget_driverReturns the identifier for the driver used to create a file.
#H5Pget_driver_infoReturns a pointer to file driver information.
#H5Pset_fapl_core/#H5Pget_fapl_coreSets the driver for buffered memory files (in RAM) or retrieves information regarding +the driver.
#H5Pset_fapl_direct/#H5Pget_fapl_directSets up use of the direct I/O driver or retrieves the direct I/O driver settings.
#H5Pset_fapl_family/#H5Pget_fapl_familySets driver for file families, designed for systems that do not support files +larger than 2 gigabytes, or retrieves information regarding driver.
#H5Pset_fapl_logSets logging driver.
#H5Pset_fapl_mpio/#H5Pget_fapl_mpioSets driver for files on parallel file systems (MPI I/O) or retrieves information +regarding the driver.
H5Pset_fapl_mpiposix/H5Pget_fapl_mpiposixNo longer available.
#H5Pset_fapl_multi/#H5Pget_fapl_multiSets driver for multiple files, separating categories of metadata and raw data, +or retrieves information regarding driver.
#H5Pset_fapl_sec2Sets driver for unbuffered permanent files or retrieves information regarding driver.
#H5Pset_fapl_splitSets driver for split files, a limited case of multiple files with one metadata file +and one raw data file.
#H5Pset_fapl_stdioSets driver for buffered permanent files.
#H5Pset_fapl_windowsSets the Windows I/O driver.
#H5Pset_multi_typeSpecifies type of data to be accessed via the MULTI driver enabling more direct access.
#H5Pget_multi_typeRetrieves type of data property for MULTI driver.
+//! [fd_pl_table] + * +//! [dcpl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Dataset creation property list functions (H5P)
FunctionPurpose
#H5Pset_layoutSets the type of storage used to store the raw data for a dataset.
#H5Pget_layoutReturns the layout of the raw data for a dataset.
#H5Pset_chunkSets the size of the chunks used to store a chunked layout dataset.
#H5Pget_chunkRetrieves the size of chunks for the raw data of a chunked layout dataset.
#H5Pset_deflateSets compression method and compression level.
#H5Pset_fill_valueSets the fill value for a dataset.
#H5Pget_fill_valueRetrieves a dataset fill value.
#H5Pfill_value_definedDetermines whether the fill value is defined.
#H5Pset_fill_timeSets the time when fill values are written to a dataset.
#H5Pget_fill_timeRetrieves the time when fill value are written to a dataset.
#H5Pset_alloc_timeSets the timing for storage space allocation.
#H5Pget_alloc_timeRetrieves the timing for storage space allocation.
#H5Pset_filterAdds a filter to the filter pipeline.
#H5Pall_filters_availVerifies that all required filters are available.
#H5Pget_nfiltersReturns the number of filters in the pipeline.
#H5Pget_filterReturns information about a filter in a pipeline. +The C function is a macro: \see \ref api-compat-macros.
#H5Pget_filter_by_idReturns information about the specified filter. +The C function is a macro: \see \ref api-compat-macros.
#H5Pmodify_filterModifies a filter in the filter pipeline.
#H5Premove_filterDeletes one or more filters in the filter pipeline.
#H5Pset_fletcher32Sets up use of the Fletcher32 checksum filter.
#H5Pset_nbitSets up use of the n-bit filter.
#H5Pset_scaleoffsetSets up use of the scale-offset filter.
#H5Pset_shuffleSets up use of the shuffle filter.
#H5Pset_szipSets up use of the Szip compression filter.
#H5Pset_externalAdds an external file to the list of external files.
#H5Pget_external_countReturns the number of external files for a dataset.
#H5Pget_externalReturns information about an external file.
#H5Pset_char_encodingSets the character encoding used to encode a string. Use to set ASCII or UTF-8 character +encoding for object names.
#H5Pget_char_encodingRetrieves the character encoding used to create a string.
+//! [dcpl_table] + * +//! [dapl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Dataset access property list functions (H5P)
FunctionPurpose
#H5Pset_bufferSets type conversion and background buffers.
#H5Pget_bufferReads buffer settings.
#H5Pset_chunk_cache/#H5Pget_chunk_cacheSets/gets the raw data chunk cache parameters.
#H5Pset_edc_check/#H5Pget_edc_checkSets/gets whether to enable error-detection when reading a dataset.
#H5Pset_filter_callbackSets user-defined filter callback function.
#H5Pset_data_transform/#H5Pget_data_transformSets/gets a data transform expression.
#H5Pset_type_conv_cb/#H5Pget_type_conv_cbSets/gets user-defined datatype conversion callback function.
#H5Pset_hyper_vector_size/#H5Pget_hyper_vector_sizeSets/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_vlen_mem_manager/#H5Pget_vlen_mem_managerSets/gets the memory manager for variable-length datatype allocation in #H5Dread and +#H5Dvlen_reclaim.
#H5Pset_dxpl_mpio/#H5Pget_dxpl_mpioSets/gets data transfer mode.
#H5Pset_dxpl_mpio_chunk_optSets a flag specifying linked-chunk I/O or multi-chunk I/O.
#H5Pset_dxpl_mpio_chunk_opt_numSets a numeric threshold for linked-chunk I/O.
#H5Pset_dxpl_mpio_chunk_opt_ratioSets a ratio threshold for collective I/O.
#H5Pset_dxpl_mpio_collective_optSets 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
#H5Pset_bufferMaximum size for the type conversion buffer and the background buffer. May also supply +pointers to application-allocated buffers.
#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_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.
+//! [dxpl_table] + * +//! [gcpl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Group creation property list functions (H5P)
FunctionPurpose
#H5Pall_filters_availVerifies that all required filters are available.
#H5Pget_filterReturns information about a filter in a pipeline. The +C function is a macro: \see \ref api-compat-macros.
#H5Pget_filter_by_idReturns information about the specified filter. The +C function is a macro: \see \ref api-compat-macros.
#H5Pget_nfiltersReturns the number of filters in the pipeline.
#H5Pmodify_filterModifies a filter in the filter pipeline.
#H5Premove_filterDeletes one or more filters in the filter pipeline.
#H5Pset_deflateSets the deflate (GNU gzip) compression method and compression level.
#H5Pset_filterAdds a filter to the filter pipeline.
#H5Pset_fletcher32Sets up use of the Fletcher32 checksum filter.
#H5Pset_link_phase_changeSets the parameters for conversion between compact and dense groups.
#H5Pget_link_phase_changeQueries the settings for conversion between compact and dense groups.
#H5Pset_est_link_infoSets estimated number of links and length of link names in a group.
#H5Pget_est_link_infoQueries data required to estimate required local heap or object header size.
#H5Pset_nlinksSets maximum number of soft or user-defined link traversals.
#H5Pget_nlinksRetrieves the maximum number of link traversals.
#H5Pset_link_creation_orderSets creation order tracking and indexing for links in a group.
#H5Pget_link_creation_orderQueries whether link creation order is tracked and/or indexed in a group.
#H5Pset_create_intermediate_groupSpecifies in the property list whether to create missing intermediate groups.
#H5Pget_create_intermediate_groupDetermines whether the property is set to enable creating missing intermediate groups.
#H5Pset_char_encodingSets the character encoding used to encode a string. Use to set ASCII or UTF-8 character +encoding for object names.
#H5Pget_char_encodingRetrieves the character encoding used to create a string.
+//! [gcpl_table] + * +//! [gapl_table] + + + + + + + + + + +
Group access property list functions (H5P)
FunctionPurpose
#H5Pset_all_coll_metadata_ops/#H5Pget_all_coll_metadata_opsSets/gets metadata I/O mode for read operations
+//! [gapl_table] + * +//! [lapl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + +
Link access property list functions (H5P)
FunctionPurpose
#H5Pset_elink_cb/#H5Pget_elink_cbSets/gets the external link traversal callback function.
#H5Pset_elink_acc_flags/#H5Pget_elink_acc_flagsSets/gets the external link traversal file access flag.
#H5Pset_elink_fapl/#H5Pget_elink_faplSets/gets a file access property list for use in accessing a file pointed to by an external link
#H5Pset_elink_prefix/#H5Pget_elink_prefixSets/gets prefix to be applied to external link paths.
#H5Pset_nlinks/#H5Pget_nlinksSets/gets maximum number of soft or user-defined link traversals.
+//! [lapl_table] + * +//! [ocpl_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Object creation property list functions (H5P)
FunctionPurpose
#H5Pset_attr_creation_order/#H5Pget_attr_creation_orderSets/gets tracking and indexing of attribute creation order.
#H5Pset_attr_phase_change/#H5Pget_attr_phase_changeSets/gets attribute storage phase change thresholds
#H5Pset_filter/#H5Pget_filterAdds/gets a filter to/from the filter pipeline.
#H5Pget_filter_by_idReturns information about a filter in a pipeline.
#H5Pget_nfiltersReturns information about the specified filter.
#H5Pset_obj_track_times/#H5Pget_obj_track_timesSets/gets the recording of times associated with an object.
#H5Pmodify_filterModifies a filter in the filter pipeline.
#H5Premove_filterDelete one or more filters in the filter pipeline.
#H5Pset_fletcher32Sets up use of the Fletcher32 checksum filter.
+//! [ocpl_table] + * +//! [ocpypl_table] + + + + + + + + + + + + + + + + + + + + + + +
Object copy property list functions (H5P)
FunctionPurpose
#H5Padd_merge_committed_dtype_pathAdds a path to the list of paths that will be searched in the destination file for a matching committed datatype.
#H5Pfree_merge_committed_dtype_pathsClears the list of paths stored in the object copy property list.
#H5Pset_copy_object/#H5Pget_copy_objectSets/gets the properties to be used when an object is copied.
#H5Pset_mcdt_search_cb/#H5Pget_mcdt_search_cbSets/gets the callback function that H5Ocopy() will invoke before searching for a matching committed datatype.
+//! [ocpypl_table] + * +//! [strcpl_table] + + + + + + + + + + + + + + +
String creation property list functions (H5P)
FunctionPurpose
#H5Pset_char_encoding/#H5Pget_char_encodingSets/gets the character encoding used to encode link and attribute names.
#H5Pset_create_intermediate_group/#H5Pget_create_intermediate_groupSpecifies/retrieves whether to create missing intermediate groups.
+//! [strcpl_table] + * +//! [lcpl_table] + + + + + + + + + + +
Link creation property list functions (H5P)
FunctionPurpose
#H5Pset_create_intermediate_group/#H5Pget_create_intermediate_groupSpecifies/retrieves whether to create missing intermediate groups.
+//! [lcpl_table] + * +//! [acpl_table] + + + + + + + + + + +
Attribute creation property list functions (H5P)
FunctionPurpose
#H5Pset_char_encoding/#H5Pget_char_encodingSets/gets the character encoding used to encode link and attribute names.
+//! [acpl_table] + * + */ + \ No newline at end of file diff --git a/src/H5Dmodule.h b/src/H5Dmodule.h index 474efd9..ad1e659 100644 --- a/src/H5Dmodule.h +++ b/src/H5Dmodule.h @@ -181,250 +181,11 @@ * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Dataset creation property list functions (H5P)
FunctionPurpose
#H5Pset_layoutSets the type of storage used to store the raw data for a dataset.
#H5Pget_layoutReturns the layout of the raw data for a dataset.
#H5Pset_chunkSets the size of the chunks used to store a chunked layout dataset.
#H5Pget_chunkRetrieves the size of chunks for the raw data of a chunked layout dataset.
#H5Pset_deflateSets compression method and compression level.
#H5Pset_fill_valueSets the fill value for a dataset.
#H5Pget_fill_valueRetrieves a dataset fill value.
#H5Pfill_value_definedDetermines whether the fill value is defined.
#H5Pset_fill_timeSets the time when fill values are written to a dataset.
#H5Pget_fill_timeRetrieves the time when fill value are written to a dataset.
#H5Pset_alloc_timeSets the timing for storage space allocation.
#H5Pget_alloc_timeRetrieves the timing for storage space allocation.
#H5Pset_filterAdds a filter to the filter pipeline.
#H5Pall_filters_availVerifies that all required filters are available.
#H5Pget_nfiltersReturns the number of filters in the pipeline.
#H5Pget_filterReturns information about a filter in a pipeline. - * The C function is a macro: \see \ref api-compat-macros.
#H5Pget_filter_by_idReturns information about the specified filter. - * The C function is a macro: \see \ref api-compat-macros.
#H5Pmodify_filterModifies a filter in the filter pipeline.
#H5Premove_filterDeletes one or more filters in the filter pipeline.
#H5Pset_fletcher32Sets up use of the Fletcher32 checksum filter.
#H5Pset_nbitSets up use of the n-bit filter.
#H5Pset_scaleoffsetSets up use of the scale-offset filter.
#H5Pset_shuffleSets up use of the shuffle filter.
#H5Pset_szipSets up use of the Szip compression filter.
#H5Pset_externalAdds an external file to the list of external files.
#H5Pget_external_countReturns the number of external files for a dataset.
#H5Pget_externalReturns information about an external file.
#H5Pset_char_encodingSets the character encoding used to encode a string. Use to set ASCII or UTF-8 character - * encoding for object names.
#H5Pget_char_encodingRetrieves the character encoding used to create a string.
+ * \anchor dcpl_table_tag Dataset creation property list functions (H5P) + * \snippet{doc} tables/propertyLists.dox dcpl_table * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Dataset access property list functions (H5P)
FunctionPurpose
#H5Pset_bufferSets type conversion and background buffers.
#H5Pget_bufferReads buffer settings.
#H5Pset_chunk_cacheSets the raw data chunk cache parameters.
#H5Pget_chunk_cacheRetrieves the raw data chunk cache parameters.
#H5Pset_edc_checkSets whether to enable error-detection when reading a dataset.
#H5Pget_edc_checkDetermines whether error-detection is enabled for dataset reads.
#H5Pset_filter_callbackSets user-defined filter callback function.
#H5Pset_data_transformSets a data transform expression.
#H5Pget_data_transformRetrieves a data transform expression.
#H5Pset_type_conv_cbSets user-defined datatype conversion callback function.
#H5Pget_type_conv_cbGets user-defined datatype conversion callback function.
#H5Pset_hyper_vector_sizeSets number of I/O vectors to be read/written in hyperslab I/O.
#H5Pget_hyper_vector_sizeRetrieves number of I/O vectors to be read/written in hyperslab I/O.
#H5Pset_btree_ratiosSets B-tree split ratios for a dataset transfer property list.
#H5Pget_btree_ratiosGets B-tree split ratios for a dataset transfer property list.
#H5Pset_vlen_mem_managerSets the memory manager for variable-length datatype allocation in #H5Dread and - * #H5Dvlen_reclaim.
#H5Pget_vlen_mem_managerGets the memory manager for variable-length datatype allocation in #H5Dread and - * #H5Dvlen_reclaim.
#H5Pset_dxpl_mpioSets data transfer mode.
#H5Pget_dxpl_mpioReturns the data transfer mode.
#H5Pset_dxpl_mpio_chunk_optSets a flag specifying linked-chunk I/O or multi-chunk I/O.
#H5Pset_dxpl_mpio_chunk_opt_numSets a numeric threshold for linked-chunk I/O.
#H5Pset_dxpl_mpio_chunk_opt_ratioSets a ratio threshold for collective I/O.
#H5Pset_dxpl_mpio_collective_optSets a flag governing the use of independent versus collective I/O.
#H5Pset_multi_typeSets the type of data property for the MULTI driver.
#H5Pget_multi_typeRetrieves the type of data property for the MULTI driver.
#H5Pset_small_data_block_sizeSets the size of a contiguous block reserved for small data.
#H5Pget_small_data_block_sizeRetrieves the current small data block size setting.
+ * \anchor dapl_table_tag Dataset access property list functions (H5P) + * \snippet{doc} tables/propertyLists.dox dapl_table * * \subsection subsec_dataset_program Programming Model for Datasets * This section explains the programming model for datasets. @@ -1105,41 +866,7 @@ * the pipeline processing: the pipeline and filter operations are identical no matter what data access * mechanism is used. * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
I/O file drivers
File DriverDescription
#H5FD_COREStore in memory (optional backing store to disk file).
#H5FD_FAMILYStore in a set of files.
#H5FD_LOGStore in logging file.
#H5FD_MPIOStore using MPI/IO.
#H5FD_MULTIStore in multiple files. There are several options to control layout.
#H5FD_SEC2Serial I/O to file using Unix “section 2” functions.
#H5FD_STDIOSerial I/O to file using Unix “stdio” functions.
+ * \snippet{doc} tables/propertyLists.dox lcpl_table * * Each file driver writes/reads contiguous blocks of bytes from a logically contiguous address * space. The file driver is responsible for managing the details of the different physical storage @@ -1156,29 +883,7 @@ * Data transfer properties set optional parameters that control parts of the data pipeline. The * function listing below shows transfer properties that control the behavior of the library. * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Data transfer property list functions
C FunctionPurpose
#H5Pset_bufferMaximum size for the type conversion buffer and the background buffer. May also supply - * pointers to application-allocated buffers.
#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_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.
+ * \snippet{doc} tables/fileDriverLists.dox file_driver_table * * Some filters and file drivers require or use additional parameters from the application program. * These can be passed in the data transfer property list. The table below shows file driver property diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h index 867ef0e..2d02e2f 100644 --- a/src/H5Fmodule.h +++ b/src/H5Fmodule.h @@ -410,204 +410,15 @@ * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
File creation property list functions
FunctionPurpose
#H5Pset_userblock/#H5Pget_userblockSets/retrieves size of userblock.
#H5Pset_sizes/#H5Pget_sizesSets/retrieves byte size of offsets and lengths used to address objects in HDF5 file.
#H5Pset_sym_k/#H5Pget_sym_kSets/retrieves size of parameters used to control symbol table nodes.
#H5Pset_istore_k/#H5Pget_istore_kSets/retrieves size of parameter used to control B-trees for indexing chunked datasets.
#H5Pset_file_imageSets an initial file image in a memory buffer.
#H5Pget_file_imageRetrieves a copy of the file image designated as the initial content and structure of a file.
#H5Pset_shared_mesg_nindexes/#H5Pget_shared_mesg_nindexesSets or retrieves number of shared object header message indexes in file - * creation property list.
#H5Pset_shared_mesg_indexConfigures the specified shared object header message index.
#H5Pget_shared_mesg_indexRetrieves the configuration settings for a shared message index.
#H5Pset_shared_mesg_phase_change/#H5Pget_shared_mesg_phase_changeSets or retrieves shared object header message storage phase change thresholds.
#H5Pget_version
+ * \anchor fcpl_table_tag File creation property list functions (H5P) + * \snippet{doc} tables/propertyLists.dox fcpl_table * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
File access property list functions
FunctionPurpose
#H5Pset_alignment/#H5Pget_alignmentSets/retrieves alignment properties.
#H5Pset_cache/#H5Pget_cacheSets/retrieves metadata cache and raw data chunk cache parameters.
#H5Pset_elink_file_cache_size/#H5Pget_elink_file_cache_sizeSets/retrieves the size of the external link open file cache from the specified - * file access property list.
#H5Pset_gc_references/#H5Pget_gc_referencesSets/retrieves garbage collecting references flag.
#H5Pset_family_offsetSets offset property for low-level access to a file in a family of files.
#H5Pget_family_offsetRetrieves a data offset from the file access property list.
#H5Pset_meta_block_size/#H5Pget_meta_block_sizeSets the minimum metadata blocksize or retrieves the current metadata block size setting.
#H5Pset_mdc_configSet the initial metadata cache configuration in the indicated File Access Property List - * to the supplied value.
#H5Pget_mdc_configGet the current initial metadata cache config-uration from the indicated File Access - * Property List.
#H5Pset_sieve_buf_size/#H5Pget_sieve_buf_sizeSets/retrieves maximum size of data sieve buffer.
#H5Pset_libver_boundsSets bounds on library versions, and indirectly format versions, to be used - * when creating objects.
#H5Pget_libver_boundsRetrieves library version bounds settings that indirectly control the format - * versions used when creating objects.
#H5Pset_small_data_block_sizeSets the size of a contiguous block reserved for small data.
#H5Pget_small_data_block_sizeRetrieves the current small data block size setting.
+ * \anchor fapl_table_tag File access property list functions (H5P) + * \snippet{doc} tables/propertyLists.dox fapl_table + * + * \anchor fd_pl_table_tag File driver property list functions (H5P) + * \snippet{doc} tables/propertyLists.dox fd_pl_table * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
File driver functions
FunctionPurpose
#H5Pset_driverSets a file driver.
#H5Pget_driverReturns the identifier for the driver used to create a file.
#H5Pget_driver_infoReturns a pointer to file driver information.
#H5Pset_fapl_core/#H5Pget_fapl_coreSets the driver for buffered memory files (in RAM) or retrieves information regarding - * the driver.
#H5Pset_fapl_direct/#H5Pget_fapl_directSets up use of the direct I/O driver or retrieves the direct I/O driver settings.
#H5Pset_fapl_family/#H5Pget_fapl_familySets driver for file families, designed for systems that do not support files - * larger than 2 gigabytes, or retrieves information regarding driver.
#H5Pset_fapl_logSets logging driver.
#H5Pset_fapl_mpio/#H5Pget_fapl_mpioSets driver for files on parallel file systems (MPI I/O) or retrieves information - * regarding the driver.
H5Pset_fapl_mpiposix/H5Pget_fapl_mpiposixNo longer available.
#H5Pset_fapl_multi/#H5Pget_fapl_multiSets driver for multiple files, separating categories of metadata and raw data, - * or retrieves information regarding driver.
#H5Pset_fapl_sec2Sets driver for unbuffered permanent files or retrieves information regarding driver.
#H5Pset_fapl_splitSets driver for split files, a limited case of multiple files with one metadata file - * and one raw data file.
#H5Pset_fapl_stdioSets driver for buffered permanent files.
#H5Pset_fapl_windowsSets the Windows I/O driver.
#H5Pset_multi_typeSpecifies type of data to be accessed via the MULTI driver enabling more direct access.
#H5Pget_multi_typeRetrieves type of data property for MULTI driver.
* * \subsection subsec_file_create Creating or Opening an HDF5 File * This section describes in more detail how to create and how to open files. @@ -864,100 +675,7 @@ * #H5FD_SEC2. Alternative layouts and drivers are designed to suit the needs of a variety of * systems, environments, and applications. The drivers are listed in the table below. * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Supported file drivers
Driver NameDriver IdentifierDescriptionRelated API
POSIX#H5FD_SEC2This driver uses POSIX file-system functions like read and write to perform I/O to a single, - * permanent file on local disk with no system buffering. This driver is POSIX-compliant and is - * the default file driver for all systems.#H5Pset_fapl_sec2
Direct#H5FD_DIRECTThis is the #H5FD_SEC2 driver except data is written to or read from the file - * synchronously without being cached by the system.#H5Pset_fapl_direct
Log#H5FD_LOGThis is the #H5FD_SEC2 driver with logging capabilities.#H5Pset_fapl_log
Windows#H5FD_WINDOWSThis driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver, - * #H5FD_SEC2. This change should not affect user applications.#H5Pset_fapl_windows
STDIO#H5FD_STDIOThis driver uses functions from the standard C stdio.h to perform I/O - * to a single, permanent file on local disk with additional system buffering.#H5Pset_fapl_stdio
Memory#H5FD_COREWith this driver, an application can work with a file in memory for faster reads and - * writes. File contents are kept in memory until the file is closed. At closing, the memory - * version of the file can be written back to disk or abandoned.#H5Pset_fapl_core
Family#H5FD_FAMILYWith this driver, the HDF5 file’s address space is partitioned into pieces and sent to - * separate storage files using an underlying driver of the user’s choice. This driver is for - * systems that do not support files larger than 2 gigabytes.#H5Pset_fapl_family
Multi#H5FD_MULTIWith this driver, data can be stored in multiple files according to the type of the data. - * I/O might work better if data is stored in separate files based on the type of data. The Split - * driver is a special case of this driver.#H5Pset_fapl_multi
SplitH5FD_SPLITThis file driver splits a file into two parts. One part stores metadata, and the other part - * stores raw data. This splitting a file into two parts is a limited case of the Multi driver.#H5Pset_fapl_split
Parallel#H5FD_MPIOThis is the standard HDF5 file driver for parallel file systems. This driver uses the MPI - * standard for both communication and file I/O.#H5Pset_fapl_mpio
Parallel POSIXH5FD_MPIPOSIXThis driver is no longer available
StreamH5FD_STREAMThis driver is no longer available.
+ * \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table * * For more information, see the HDF5 Reference Manual entries for the function calls shown in * the column on the right in the table above. diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h index defa5fa..4b58ee6 100644 --- a/src/H5Gmodule.h +++ b/src/H5Gmodule.h @@ -480,100 +480,7 @@ * * * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
Group creation property list functions
FunctionPurpose
#H5Pall_filters_availVerifies that all required filters are available.
#H5Pget_filterReturns information about a filter in a pipeline. The - * C function is a macro: \see \ref api-compat-macros.
#H5Pget_filter_by_idReturns information about the specified filter. The - * C function is a macro: \see \ref api-compat-macros.
#H5Pget_nfiltersReturns the number of filters in the pipeline.
#H5Pmodify_filterModifies a filter in the filter pipeline.
#H5Premove_filterDeletes one or more filters in the filter pipeline.
#H5Pset_deflateSets the deflate (GNU gzip) compression method and compression level.
#H5Pset_filterAdds a filter to the filter pipeline.
#H5Pset_fletcher32Sets up use of the Fletcher32 checksum filter.
#H5Pset_link_phase_changeSets the parameters for conversion between compact and dense groups.
#H5Pget_link_phase_changeQueries the settings for conversion between compact and dense groups.
#H5Pset_est_link_infoSets estimated number of links and length of link names in a group.
#H5Pget_est_link_infoQueries data required to estimate required local heap or object header size.
#H5Pset_nlinksSets maximum number of soft or user-defined link traversals.
#H5Pget_nlinksRetrieves the maximum number of link traversals.
#H5Pset_link_creation_orderSets creation order tracking and indexing for links in a group.
#H5Pget_link_creation_orderQueries whether link creation order is tracked and/or indexed in a group.
#H5Pset_create_intermediate_groupSpecifies in the property list whether to create missing intermediate groups.
#H5Pget_create_intermediate_groupDetermines whether the property is set to enable creating missing intermediate groups.
#H5Pset_char_encodingSets the character encoding used to encode a string. Use to set ASCII or UTF-8 character - * encoding for object names.
#H5Pget_char_encodingRetrieves the character encoding used to create a string.
+ * \snippet{doc} tables/propertyLists.dox gcpl_table * * * diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index d5ef982..38d06e2 100644 --- a/src/H5Pmodule.h +++ b/src/H5Pmodule.h @@ -788,9 +788,9 @@ *
  • \ref subsec_file_property_lists
    • *
  • \ref subsubsec_file_examples_props
    • *
  • \ref subsubsec_file_examples_access
    • - *
  • "File creation property list functions (H5P)"
    • - *
  • "File access property list functions (H5P)"
    • - *
  • "File driver functions (H5P)"
    • + *
  • \ref dcpl_table_tag "Dataset creation property list functions (H5P)"
    • + *
  • \ref fapl_table_tag "File access property list functions (H5P)"
    • + *
  • \ref fd_pl_table_tag "File driver property list functions (H5P)"
    • * \li In the \ref sec_attribute chapter, see "Attribute creation property list functions (H5P)". * \li In the \ref sec_group chapter, see "Group creation property list functions (H5P)". * \li Property lists are discussed throughout \ref sec_dataset. @@ -798,16 +798,16 @@ * All property list functions are described in the \ref H5P section of the * \ref RM. The function index at the top of the page provides a categorized listing * grouped by property list class. Those classes are listed below: - * \li File creation properties - * \li File access properties - * \li Group creation properties - * \li Dataset creation properties - * \li Dataset access properties - * \li Dataset transfer properties - * \li Link creation properties - * \li Link access properties - * \li Object creation properties - * \li Object copy properties + * \li \ref FCPL + * \li \ref FAPL + * \li \ref GCPL + * \li \ref DCPL + * \li \ref DAPL + * \li \ref DXPL + * \li \ref LCPL + * \li \ref LAPL + * \li \ref OCPL + * \li \ref OCPYPL * * Additional categories not related to the class structure are as follows: * \li General property list operations @@ -893,135 +893,184 @@ * or writing data. Property lists can be modified by adding or changing * properties. Property lists are deleted by closing the associated handles. * - *
    Other external link functions
    - * - * - * - * - * - * - * - * - * - *
    CreateRead
    - * \snippet{lineno} H5P_examples.c create - * - * \snippet{lineno} H5P_examples.c read - *
    UpdateDelete
    - * \snippet{lineno} H5P_examples.c update - * - * \snippet{lineno} H5P_examples.c delete - *
    + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox plcr_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox plcra_table + * + * \ref PLCR / \ref OCPL / \ref GCPL + * \snippet{doc} tables/propertyLists.dox fcpl_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox fapl_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox lapl_table + * + * \ref PLCR / \ref OCPL + * \snippet{doc} tables/propertyLists.dox dcpl_table + * + * \ref PLCR / \ref LAPL + * \snippet{doc} tables/propertyLists.dox dapl_table + * + * \ref PLCR / \ref OCPL + * \snippet{doc} tables/propertyLists.dox gcpl_table + * + * \ref PLCR / \ref LAPL + * \snippet{doc} tables/propertyLists.dox gapl_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox ocpl_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox ocpypl_table + * + * \ref PLCR + * \snippet{doc} tables/propertyLists.dox strcpl_table + * + * \ref PLCR / \ref STRCPL + * \snippet{doc} tables/propertyLists.dox lcpl_table + * + * \ref PLCR / \ref STRCPL + * \snippet{doc} tables/propertyLists.dox acpl_table + * * * \defgroup STRCPL String Creation Properties + * \ingroup H5P * Currently, there are only two creation properties that you can use to control * the creation of HDF5 attributes and links. The first creation property, the * choice of a character encoding, applies to both attributes and links. * The second creation property applies to links only, and advises the library * to automatically create missing intermediate groups when creating new objects. - * \ingroup H5P + * + * \snippet{doc} tables/propertyLists.dox strcpl_table * * \defgroup LCPL Link Creation Properties - * The first creation property, the choice of a character encoding, applies to - * both attributes and links. - * The second creation property applies to links only, and advises the library - * to automatically create missing intermediate groups when creating new objects. * \ingroup STRCPL + * This creation property applies to links only, and advises the library + * to automatically create missing intermediate groups when creating new objects. + * + * \snippet{doc} tables/propertyLists.dox lcpl_table * * @see STRCPL * * \defgroup ACPL Attribute Creation Properties - * The creation property, the choice of a character encoding, applies to attributes. * \ingroup STRCPL + * The creation property, the choice of a character encoding, applies to attributes. + * + * \snippet{doc} tables/propertyLists.dox acpl_table * * @see STRCPL * * \defgroup LAPL Link Access Properties * \ingroup H5P * + * \snippet{doc} tables/propertyLists.dox lapl_table + * * \defgroup DAPL Dataset Access Properties + * \ingroup LAPL * Use dataset access properties to modify the default behavior of the HDF5 * library when accessing datasets. The properties include adjusting the size * of the chunk cache, providing prefixes for external content and virtual * dataset file paths, and controlling flush behavior, etc. These properties * are \Emph{not} persisted with datasets, and can be adjusted at runtime before * a dataset is created or opened. - * \ingroup LAPL + * + * \snippet{doc} tables/propertyLists.dox dapl_table * * \defgroup DCPL Dataset Creation Properties + * \ingroup OCPL * Use dataset creation properties to control aspects of dataset creation such * as fill time, storage layout, compression methods, etc. * Unlike dataset access and transfer properties, creation properties \Emph{are} * stored with the dataset, and cannot be changed once a dataset has been * created. - * \ingroup OCPL + * + * \snippet{doc} tables/propertyLists.dox dcpl_table * * \defgroup DXPL Dataset Transfer Properties + * \ingroup H5P * Use dataset transfer properties to customize certain aspects of reading * and writing datasets such as transformations, MPI-IO I/O mode, error * detection, etc. These properties are \Emph{not} persisted with datasets, * and can be adjusted at runtime before a dataset is read or written. - * \ingroup H5P + * + * \snippet{doc} tables/propertyLists.dox dxpl_table * * \defgroup FAPL File Access Properties + * \ingroup H5P * Use file access properties to modify the default behavior of the HDF5 * library when accessing files. The properties include selecting a virtual * file driver (VFD), configuring the metadata cache (MDC), control * file locking, etc. These properties are \Emph{not} persisted with files, and * can be adjusted at runtime before a file is created or opened. - * \ingroup H5P + * + * \snippet{doc} tables/propertyLists.dox fapl_table * * \defgroup FCPL File Creation Properties + * \ingroup GCPL * Use file creation properties to control aspects of file creation such * as setting a file space management strategy or creating a user block. * Unlike file access properties, creation properties \Emph{are} * stored with the file, and cannot be changed once a file has been * created. - * \ingroup GCPL * - * \defgroup GAPL General Access Properties - * The functions in this section can be applied to different kinds of property - * lists. + * \snippet{doc} tables/propertyLists.dox fcpl_table + * + * \defgroup GAPL Group Access Properties * \ingroup LAPL + * The functions in this section can be applied to group property lists. + * + * \snippet{doc} tables/propertyLists.dox gapl_table * * \defgroup GCPL Group Creation Properties + * \ingroup OCPL * Use group creation properties to control aspects of group creation such * as storage layout, compression, and link creation order tracking. * Unlike file access properties, creation properties \Emph{are} * stored with the group, and cannot be changed once a group has been * created. - * \ingroup OCPL + * + * \snippet{doc} tables/propertyLists.dox gcpl_table * * \defgroup PLCR Property List Class Root - * Use the functions in this module to manage HDF5 property lists. * \ingroup H5P + * Use the functions in this module to manage HDF5 property lists. + * + * \snippet{doc} tables/propertyLists.dox plcr_table * * \defgroup PLCRA Property List Class Root (Advanced) + * \ingroup H5P * You can create and customize user-defined property list classes using the * functions described below. Arbitrary user-defined properties can also * be inserted into existing property lists as so-called temporary properties. - * \ingroup H5P * + * \snippet{doc} tables/propertyLists.dox plcra_table * * \defgroup OCPL Object Creation Properties * \ingroup H5P * + * \snippet{doc} tables/propertyLists.dox ocpl_table + * * \defgroup OCPYPL Object Copy Properties * \ingroup H5P * + * \snippet{doc} tables/propertyLists.dox ocpypl_table + * * \defgroup FMPL File Mount Properties - * Empty property class. * \ingroup H5P + * Empty property class. * * * \defgroup TCPL Datatype Creation Properties - * TCPL isn't supported yet. * \ingroup OCPL + * TCPL isn't supported yet. * * * \defgroup TAPL Datatype Access Properties - * TAPL isn't supported yet. * \ingroup LAPL + * TAPL isn't supported yet. * * * diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 5bf2b21..350c7dc 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -8202,9 +8202,8 @@ H5_DLL herr_t H5Pset_dataset_io_hyperslab_selection(hid_t plist_id, unsigned ran const hsize_t start[], const hsize_t stride[], const hsize_t count[], const hsize_t block[]); -/* Link creation property list (LCPL) routines */ /** - * \ingroup STRCPL + * \ingroup LCPL * * \brief Determines whether property is set to enable creating missing * intermediate groups @@ -8235,7 +8234,7 @@ H5_DLL herr_t H5Pset_dataset_io_hyperslab_selection(hid_t plist_id, unsigned ran */ H5_DLL herr_t H5Pget_create_intermediate_group(hid_t plist_id, unsigned *crt_intmd /*out*/); /** - * \ingroup STRCPL + * \ingroup LCPL * * \brief Specifies in property list whether to create missing * intermediate groups @@ -8617,9 +8616,8 @@ H5_DLL herr_t H5Pget_map_iterate_hints(hid_t mapl_id, size_t *key_prefetch_size size_t *key_alloc_size /*out*/); #endif /* H5_HAVE_MAP_API */ -/* String creation property list (STRCPL) routines */ /** - * \ingroup STRCPL + * \ingroup ACPL * * \brief Retrieves the character encoding used to create a link or * attribute name @@ -8648,7 +8646,7 @@ H5_DLL herr_t H5Pget_map_iterate_hints(hid_t mapl_id, size_t *key_prefetch_size */ H5_DLL herr_t H5Pget_char_encoding(hid_t plist_id, H5T_cset_t *encoding /*out*/); /** - * \ingroup STRCPL + * \ingroup ACPL * * \brief Sets the character encoding used to encode link and attribute * names -- cgit v0.12