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/H5module.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/H5module.h')
-rw-r--r-- | src/H5module.h | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/src/H5module.h b/src/H5module.h index f37dfc7..d335d87 100644 --- a/src/H5module.h +++ b/src/H5module.h @@ -26,6 +26,48 @@ #define H5_MY_PKG_ERR H5E_LIB #define H5_MY_PKG_INIT NO +/** \page H5DM_UG The HDF5 Data Model and File Structure + * + * \section sec_data_model The HDF5 Data Model and File Structure + * \subsection subsec_data_model_intro Introduction + * \subsection subsec_data_model_abstract The Abstract Data Model + * \subsubsection subsubsec_data_model_abstract_file File + * \subsubsection subsubsec_data_model_abstract_group Group + * \subsubsection subsubsec_data_model_abstract_dataset Dataset + * \subsubsection subsubsec_data_model_abstract_space Dataspace + * \subsubsection subsubsec_data_model_abstract_type Datatype + * \subsubsection subsubsec_data_model_abstract_attr Attribute + * \subsubsection subsubsec_data_model_abstract_plist Property List + * \subsubsection subsubsec_data_model_abstract_link Link + * \subsection subsec_data_model_storage The HDF5 Storage Model + * \subsubsection subsubsec_data_model_storage_spec The Abstract Storage Model: the HDF5 Format Specification + * \subsubsection subsubsec_data_model_storage_imple Concrete Storage Model + * \subsection subsec_data_model_structure The Structure of an HDF5 File + * \subsubsection subsubsec_data_model_structure_file Overall File Structure + * \subsubsection subsubsec_data_model_structure_path HDF5 Path Names and Navigation + * \subsubsection subsubsec_data_model_structure_example Examples of HDF5 File Structures + * + */ + +/** \page H5_UG The HDF5 Library and Programming Model + * + * \section sec_program The HDF5 Library and Programming Model + * \subsection subsec_program_intro Introduction + * \subsection subsec_program_model The HDF5 Programming Model + * \subsubsection subsubsec_program_model_create Creating an HDF5 File + * \subsubsection subsubsec_program_model_dset Creating and Initializing a Dataset + * \subsubsection subsubsec_program_model_close Closing an Object + * \subsubsection subsubsec_program_model_data Writing or Reading a Dataset to or from a File + * \subsubsection subsubsec_program_model_partial Reading and Writing a Portion of a Dataset + * \subsubsection subsubsec_program_model_info Getting Information about a Dataset + * \subsubsection subsubsec_program_model_compound Creating and Defining Compound Datatypes + * \subsubsection subsubsec_program_model_extend Creating and Writing Extendable Datasets + * \subsubsection subsubsec_program_model_group Creating and Working with Groups + * \subsubsection subsubsec_program_model_attr Working with Attributes + * \subsection subsec_program_transfer_pipeline The Data Transfer Pipeline + * + */ + /**\defgroup H5 H5 * * Use the functions in this module to manage the life cycle of HDF5 library |