hdf5/doxygen/dox/high_level/high_level.dox
vchoi-hdfgroup 9e97a22b8b
Add doxygen for high level modules. (#1839)
* Add doxygen for high level modules.

* Committing clang-format changes

* Correct spelling based on spelling check.

* Committing clang-format changes

Co-authored-by: vchoi <vchoi@jelly.ad.hdfgroup.org>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
2022-07-01 08:42:15 -07:00

30 lines
1.1 KiB
Plaintext

/** \page high_level High-level library
* The high-level HDF5 library includes several sets of convenience and standard-use APIs to
* facilitate common HDF5 operations.
*
* <ul>
* <li>\ref H5LT "Lite (H5LT, H5LD)"
* \n
* Functions to simplify creating and manipulating datasets, attributes and other features
* <li>\ref H5IM "Image (H5IM)"
* \n
* Creating and manipulating HDF5 datasets intended to be interpreted as images
* <li>\ref H5TB "Table (H5TB)"
* \n
* Creating and manipulating HDF5 datasets intended to be interpreted as tables
* <li>\ref H5PT "Packet Table (H5PT)"
* \n
* Creating and manipulating HDF5 datasets to support append- and read-only operations on table data
* <li>\ref H5DS "Dimension Scale (H5DS)"
* \n
* Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset
* <li>\ref H5DO "Optimizations (H5DO)"
* \n
* Bypassing default HDF5 behavior in order to optimize for specific use cases
* <li>\ref H5LR "Extensions (H5LR, H5LT)"
* \n
* Working with region references, hyperslab selections, and bit-fields
* </ul>
*
*/