diff options
| author | bljhdf <58825073+bljhdf@users.noreply.github.com> | 2020-11-23 22:17:44 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-23 22:17:44 (GMT) |
| commit | c56464fc36a78167c22b84e4cfef0e0c2aafce80 (patch) | |
| tree | e10abc0a4c439f6723295a3aa7227e3d54b4552c /src/H5Pmodule.h | |
| parent | ecbcb4356c2bbdad7ad801f9c61fe695082a6b25 (diff) | |
| download | hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.zip hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.gz hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.bz2 | |
Doxygen - added (mostly) beginner functions (#112)
* Doxygen - added (mostly) beginner functions
* Removed duplicate H5Pset_szip function
Diffstat (limited to 'src/H5Pmodule.h')
| -rw-r--r-- | src/H5Pmodule.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h index d8cc430..b9e1180 100644 --- a/src/H5Pmodule.h +++ b/src/H5Pmodule.h @@ -29,4 +29,47 @@ #define H5_MY_PKG_ERR H5E_PLIST #define H5_MY_PKG_INIT YES +/**\defgroup H5P H5P + * \brief Property List Interface + * + * \details The HDF5 Property List Interface provides a mechanism to take + * advantage of more powerful or unusual features in HDF5. + * + * HDF5 objects have properties or characteristics associated with + * them, and there are default properties that handle the most + * common needs. These default properties can be modified using the + * HDF5 Property List Interface. For example, the data storage + * layout property of a dataset is contiguous by default. For better + * performance, the layout can be modified to be chunked or chunked + * and compressed. + * + * \todo Describe concisely what the functions in this module are about. + * \todo Clicking on "more" after "Property List Interface" at the top does not work + * + * \defgroup GPLO General Property List Operations + * \ingroup H5P + * \defgroup GPLOA General Property List Operations (Advanced) + * \ingroup H5P + * \defgroup FCPL File Creation Properties + * \ingroup H5P + * \defgroup FAPL File Access Properties + * \ingroup H5P + * \defgroup GCPL Group Creation Properties + * \ingroup H5P + * \defgroup ALCAPL Attribute and Link Creation Properties + * \ingroup H5P + * \defgroup LAPL Link Access Properties + * \ingroup H5P + * \defgroup DCPL Dataset Creation Properties + * \ingroup H5P + * \defgroup DAPL Dataset Access Properties + * \ingroup H5P + * \defgroup DXPL Dataset Transfer Properties + * \ingroup H5P + * \defgroup OCPL Object Creation Properties + * \ingroup H5P + * \defgroup OCPPL Object Copy Properties + * \ingroup H5P + */ + #endif /* _H5Pmodule_H */ |