Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release information to enum constants - Part 3 #5234

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Add release information to enum constants - Part 3 #5234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
835e69c
Add release information to enum constants - Part 3
bmribler Jan 14, 2025
ec93228
Committing clang-format changes
github-actions[bot] Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 22 additions & 16 deletions src/H5Mpublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,17 @@

/* Macros defining operation IDs for map VOL callbacks (implemented using the
* "optional" VOL callback) */
#define H5VL_MAP_CREATE 1 /**< Callback operation ID for map create */
#define H5VL_MAP_OPEN 2 /**< Callback operation ID for map open */
#define H5VL_MAP_GET_VAL 3 /**< Callback operation ID for getting an associated value from a map */
#define H5VL_MAP_EXISTS 4 /**< Callback operation ID for checking if a value exists in a map */
#define H5VL_MAP_PUT 5 /**< Callback operation ID for putting a key-value pair to a map */
#define H5VL_MAP_GET 6 /**< Callback operation ID for map get callback */
#define H5VL_MAP_SPECIFIC 7 /**< Callback operation ID for map specific operation */
#define H5VL_MAP_OPTIONAL 8 /**< Currently unused */
#define H5VL_MAP_CLOSE 9 /**< Callback operation ID for terminating access to a map */
#define H5VL_MAP_CREATE 1 /**< Callback operation ID for map create \since 1.12.0 */
#define H5VL_MAP_OPEN 2 /**< Callback operation ID for map open \since 1.12.0 */
#define H5VL_MAP_GET_VAL \
3 /**< Callback operation ID for getting an associated value from a map \since 1.12.0 */
#define H5VL_MAP_EXISTS 4 /**< Callback operation ID for checking if a value exists in a map \since 1.12.0 \
*/
#define H5VL_MAP_PUT 5 /**< Callback operation ID for putting a key-value pair to a map \since 1.12.0 */
#define H5VL_MAP_GET 6 /**< Callback operation ID for map get callback \since 1.12.0 */
#define H5VL_MAP_SPECIFIC 7 /**< Callback operation ID for map specific operation \since 1.12.0 */
#define H5VL_MAP_OPTIONAL 8 /**< Currently unused \since 1.12.0 */
#define H5VL_MAP_CLOSE 9 /**< Callback operation ID for terminating access to a map \since 1.12.0 */

/*******************/
/* Public Typedefs */
Expand All @@ -50,19 +52,23 @@
* Types for map GET callback
*/
typedef enum H5VL_map_get_t {
H5VL_MAP_GET_MAPL, /**< Callback operation ID for getting map access property list */
H5VL_MAP_GET_MCPL, /**< Callback operation ID for getting map creation property list */
H5VL_MAP_GET_KEY_TYPE, /**< Callback operation ID for getting the key datatype for a map */
H5VL_MAP_GET_VAL_TYPE, /**< Callback operation ID for getting the value datatype for a map */
H5VL_MAP_GET_COUNT /**< Callback operation ID for getting the number of key-value pairs stored in a map */
H5VL_MAP_GET_MAPL, /**< Callback operation ID for getting map access property list \since 1.12.0 */
H5VL_MAP_GET_MCPL, /**< Callback operation ID for getting map creation property list \since 1.12.0 */
H5VL_MAP_GET_KEY_TYPE, /**< Callback operation ID for getting the key datatype for a map \since 1.12.0 */
H5VL_MAP_GET_VAL_TYPE, /**< Callback operation ID for getting the value datatype for a map \since 1.12.0
*/
H5VL_MAP_GET_COUNT /**< Callback operation ID for getting the number of key-value pairs stored in a map
\since 1.12.0 */
} H5VL_map_get_t;

/**
* Types for map SPECIFIC callback
*/
typedef enum H5VL_map_specific_t {
H5VL_MAP_ITER, /**< Callback operation ID for iterating over all key-value pairs stored in the map */
H5VL_MAP_DELETE /**< Callback operation ID for deleting a key-value pair stored in the map */
H5VL_MAP_ITER, /**< Callback operation ID for iterating over all key-value pairs stored in the map
\since 1.12.0 */
H5VL_MAP_DELETE /**< Callback operation ID for deleting a key-value pair stored in the map \since 1.12.0
*/
} H5VL_map_specific_t;

//! <!-- [H5M_iterate_t_snip] -->
Expand Down
4 changes: 2 additions & 2 deletions src/H5Opublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
* Flags for H5Oget_native_info(). These flags determine which fields will be
* filled in the \ref H5O_native_info_t struct.
*/
#define H5O_NATIVE_INFO_HDR 0x0008u /**< Fill in the hdr field */
#define H5O_NATIVE_INFO_META_SIZE 0x0010u /**< Fill in the meta_size field */
#define H5O_NATIVE_INFO_HDR 0x0008u /**< Fill in the hdr field \since 1.12.0 */
#define H5O_NATIVE_INFO_META_SIZE 0x0010u /**< Fill in the meta_size field \since 1.12.0 */
#define H5O_NATIVE_INFO_ALL (H5O_NATIVE_INFO_HDR | H5O_NATIVE_INFO_META_SIZE)
//! <!-- [H5O_native_info_fields_snip] -->

Expand Down
14 changes: 7 additions & 7 deletions src/H5Rpublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@
* encoded into the datatype message header.
*/
typedef enum {
H5R_BADTYPE = (-1), /**< Invalid reference type */
H5R_OBJECT1 = 0, /**< Backward compatibility (object) */
H5R_DATASET_REGION1 = 1, /**< Backward compatibility (region) */
H5R_OBJECT2 = 2, /**< Object reference */
H5R_DATASET_REGION2 = 3, /**< Region reference */
H5R_ATTR = 4, /**< Attribute Reference */
H5R_MAXTYPE = 5 /**< Highest type (invalid) */
H5R_BADTYPE = (-1), /**< Invalid reference type \since 1.0.0 */
H5R_OBJECT1 = 0, /**< Backward compatibility (object) \since 1.12.0 */
H5R_DATASET_REGION1 = 1, /**< Backward compatibility (region) \since 1.12.0 */
H5R_OBJECT2 = 2, /**< Object reference \since 1.12.0 */
H5R_DATASET_REGION2 = 3, /**< Region reference \since 1.12.0 */
H5R_ATTR = 4, /**< Attribute Reference \since 1.12.0 */
H5R_MAXTYPE = 5 /**< Highest type (invalid) \since 1.0.0 */
} H5R_type_t;
//! <!-- [H5R_type_t_snip] -->

Expand Down
44 changes: 29 additions & 15 deletions src/H5Spublic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,38 +60,44 @@
* increasing offset order. Note that the order is only increasing \
* for each call to H5Sget_seq_list(), the next set of sequences \
* could start with an earlier offset than the previous one. \
* \
* \since 1.12.0 \
*/
#define H5S_SEL_ITER_SHARE_WITH_DATASPACE \
0x0002 /**< Don't copy the dataspace selection when creating the selection \
* iterator. This can improve performance of creating the iterator, \
* but the dataspace \Bold{MUST NOT} be modified or closed until the \
* selection iterator is closed or the iterator's behavior will be \
* undefined. \
* \
* \since 1.12.0 \
*/

/**
* Types of dataspaces
*/
typedef enum H5S_class_t {
H5S_NO_CLASS = -1, /**< Error */
H5S_SCALAR = 0, /**< Singleton (scalar) */
H5S_SIMPLE = 1, /**< Regular grid */
H5S_NULL = 2 /**< Empty set */
H5S_NO_CLASS = -1, /**< Error \since 1.0.0 */
H5S_SCALAR = 0, /**< Singleton (scalar) \since 1.0.0 */
H5S_SIMPLE = 1, /**< Regular grid \since 1.0.0 */
H5S_NULL = 2 /**< Empty set \since 1.8.0 */
} H5S_class_t;

/**
* Different ways of combining selections
*/
typedef enum H5S_seloper_t {
H5S_SELECT_NOOP = -1, /**< Error */
H5S_SELECT_SET = 0, /**< Select "set" operation */
H5S_SELECT_NOOP = -1, /**< Error \since 1.0.0 */
H5S_SELECT_SET = 0, /**< Select "set" operation \since 1.0.0 */
H5S_SELECT_OR, /**< Binary "or" operation for hyperslabs
* (add new selection to existing selection)
* \code
* Original region: AAAAAAAAAA
* New region: BBBBBBBBBB
* A or B: CCCCCCCCCCCCCCCC
* \endcode
*
* \since 1.0.0
*/
H5S_SELECT_AND, /**< Binary "and" operation for hyperslabs
* (only leave overlapped regions in selection)
Expand All @@ -100,6 +106,8 @@ typedef enum H5S_seloper_t {
* New region: BBBBBBBBBB
* A and B: CCCC
* \endcode
*
* \since 1.6.0
*/
H5S_SELECT_XOR, /**< Binary "xor" operation for hyperslabs
* (only leave non-overlapped regions in selection)
Expand All @@ -108,6 +116,8 @@ typedef enum H5S_seloper_t {
* New region: BBBBBBBBBB
* A xor B: CCCCCC CCCCCC
* \endcode
*
* \since 1.6.0
*/
H5S_SELECT_NOTB, /**< Binary "not" operation for hyperslabs
* (only leave non-overlapped regions in original selection)
Expand All @@ -116,6 +126,8 @@ typedef enum H5S_seloper_t {
* New region: BBBBBBBBBB
* A not B: CCCCCC
* \endcode
*
* \since 1.6.0
*/
H5S_SELECT_NOTA, /**< Binary "not" operation for hyperslabs
* (only leave non-overlapped regions in new selection)
Expand All @@ -124,22 +136,24 @@ typedef enum H5S_seloper_t {
* New region: BBBBBBBBBB
* B not A: CCCCCC
* \endcode
*
* \since 1.6.0
*/
H5S_SELECT_APPEND, /**< Append elements to end of point selection */
H5S_SELECT_PREPEND, /**< Prepend elements to beginning of point selection */
H5S_SELECT_INVALID /**< Invalid upper bound on selection operations */
H5S_SELECT_APPEND, /**< Append elements to end of point selection \since 1.4.0 */
H5S_SELECT_PREPEND, /**< Prepend elements to beginning of point selection \since 1.4.0 */
H5S_SELECT_INVALID /**< Invalid upper bound on selection operations \since 1.0.0 */
} H5S_seloper_t;

/**
* Selection type
*/
typedef enum {
H5S_SEL_ERROR = -1, /**< Error */
H5S_SEL_NONE = 0, /**< Empty selection */
H5S_SEL_POINTS = 1, /**< Set of points */
H5S_SEL_HYPERSLABS = 2, /**< Hyperslab */
H5S_SEL_ALL = 3, /**< Everything */
H5S_SEL_N /**< Sentinel \internal THIS MUST BE LAST */
H5S_SEL_ERROR = -1, /**< Error \since 1.0.0 */
H5S_SEL_NONE = 0, /**< Empty selection \since 1.0.0 */
H5S_SEL_POINTS = 1, /**< Set of points \since 1.0.0 */
H5S_SEL_HYPERSLABS = 2, /**< Hyperslab \since 1.0.0 */
H5S_SEL_ALL = 3, /**< Everything \since 1.0.0 */
H5S_SEL_N /**< Sentinel \internal THIS MUST BE LAST \since 1.0.0 */
} H5S_sel_type;

#ifdef __cplusplus
Expand Down
Loading