diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2024-01-18 17:03:43 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-18 17:03:43 (GMT) |
| commit | 5ae4ecc1f20659b3abffcc4098a91e085173017b (patch) | |
| tree | ff386d0a01c495d81703b5a8baa1baa6ea32729d /src/H5Zpublic.h | |
| parent | b72cc4f7f4efead63c3a2582ce472ce8a5b5b0ae (diff) | |
| download | hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.zip hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.tar.gz hdf5-5ae4ecc1f20659b3abffcc4098a91e085173017b.tar.bz2 | |
Clean up Doxygen for szip functions and constants (#3943)
Diffstat (limited to 'src/H5Zpublic.h')
| -rw-r--r-- | src/H5Zpublic.h | 49 |
1 files changed, 40 insertions, 9 deletions
diff --git a/src/H5Zpublic.h b/src/H5Zpublic.h index 44d91c0..bd557fc 100644 --- a/src/H5Zpublic.h +++ b/src/H5Zpublic.h @@ -110,24 +110,55 @@ typedef int H5Z_filter_t; */ #define H5Z_FLAG_SKIP_EDC 0x0200 -/* Special parameters for szip compression */ -/* [These are aliases for the similar definitions in szlib.h, which we can't - * include directly due to the duplication of various symbols with the zlib.h - * header file] */ +/* Special parameters for szip compression + * + * These are aliases for similarly-named definitions in szlib.h, which we + * can't include directly due to the duplication of various symbols with the + * zlib.h header file. + * + * The flag values are set to the same values as in szlib.h. The following + * symbols are internal and defined in H5Zprivate.h: + * + * - H5_SZIP_LSB_OPTION_MASK + * - H5_SZIP_MSB_OPTION_MASK + * - H5_SZIP_RAW_OPTION_MASK + * + * TODO: These symbols should probably be deprecated and moved to H5Zprivate.h + * in the next major release of the library since they are only used + * internally: + * + * - H5_SZIP_ALLOW_K13_OPTION_MASK + * - H5_SZIP_CHIP_OPTION_MASK + */ /** - * \ingroup SZIP */ + * \ingroup SZIP + * + * Used internally. Always added to the \p options_mask parameter of H5Pset_szip(). + */ #define H5_SZIP_ALLOW_K13_OPTION_MASK 1 /** - * \ingroup SZIP */ + * \ingroup SZIP + * + * Used internally. Always removed from the \p options_mask parameter of H5Pset_szip(). + */ #define H5_SZIP_CHIP_OPTION_MASK 2 /** - * \ingroup SZIP */ + * \ingroup SZIP + * + * Use the entropy coding method + */ #define H5_SZIP_EC_OPTION_MASK 4 /** - * \ingroup SZIP */ + * \ingroup SZIP + * + * Use nearest neighbor preprocessing and then the entropy coding method + */ #define H5_SZIP_NN_OPTION_MASK 32 /** - * \ingroup SZIP */ + * \ingroup SZIP + * + * The maximum number of pixels per block (see H5Pset_szip()) + */ #define H5_SZIP_MAX_PIXELS_PER_BLOCK 32 /* Macros for the shuffle filter */ |