diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-05-14 04:25:07 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-14 04:25:07 (GMT) |
| commit | 4d2b244e73f108676d4514c9332180e63cf52e52 (patch) | |
| tree | 5221c9029abf8296fb2db9b6df65e0055dd35278 /src/H5Dmodule.h | |
| parent | 47fb7b8bc7da7db75e11f1234465fae7fac6827e (diff) | |
| download | hdf5-4d2b244e73f108676d4514c9332180e63cf52e52.zip hdf5-4d2b244e73f108676d4514c9332180e63cf52e52.tar.gz hdf5-4d2b244e73f108676d4514c9332180e63cf52e52.tar.bz2 | |
Add H5P doxygen chapter (#1762)
Diffstat (limited to 'src/H5Dmodule.h')
| -rw-r--r-- | src/H5Dmodule.h | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/src/H5Dmodule.h b/src/H5Dmodule.h index 596fd48..d23d34a 100644 --- a/src/H5Dmodule.h +++ b/src/H5Dmodule.h @@ -29,7 +29,35 @@ #define H5_MY_PKG_ERR H5E_DATASET #define H5_MY_PKG_INIT YES -/**\defgroup H5D H5D +/** \page H5D_UG HDF5 Datasets + * + * \section sec_dataset HDF5 Datasets + * \subsection subsec_dataset_intro Introduction + * \subsection subsec_dataset_function Dataset Function Summaries + * \subsection subsec_dataset_program Programming Model for Datasets + * \subsubsection subsubsec_dataset_program_general General Model + * \subsubsection subsubsec_dataset_program_create Create Dataset + * \subsubsection subsubsec_dataset_program_transfer Data Transfer Operations on a Dataset + * \subsubsection subsubsec_dataset_program_read Retrieve the Properties of a Dataset + * \subsection subsec_dataset_transfer Data Transfer + * \subsubsection subsubsec_dataset_transfer_pipe The Data Pipeline + * \subsubsection subsubsec_dataset_transfer_filter Data Pipeline Filters + * \subsubsection subsubsec_dataset_transfer_drive File Drivers + * \subsubsection subsubsec_dataset_transfer_props Data Transfer Properties to Manage the Pipeline + * \subsubsection subsubsec_dataset_transfer_store Storage Strategies + * \subsubsection subsubsec_dataset_transfer_partial Partial I/O Sub‐setting and Hyperslabs + * \subsection subsec_dataset_allocation Allocation of Space in the File + * \subsubsection subsubsec_dataset_allocation_store Storage Allocation in the File: Early, Incremental, Late + * \subsubsection subsubsec_dataset_allocation_delete Deleting a Dataset from a File and Reclaiming Space + * \subsubsection subsubsec_dataset_allocation_release Releasing Memory Resources + * \subsubsection subsubsec_dataset_allocation_ext External Storage Properties + * \subsection subsec_dataset_filters Using HDF5 Filters + * \subsubsection subsubsec_dataset_filters_nbit N‐bit Filter + * \subsubsection subsubsec_dataset_filters_scale Scale‐offset Filter + * \subsubsection subsubsec_dataset_filters_szip Szip Filter + */ + +/**\defgroup H5D H5D Datasets * * Use the functions in this module to manage HDF5 datasets, including the * transfer of data between memory and disk and the description of dataset |