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.

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 cont. #5240

Merged
merged 2 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/H5Epublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#include "H5public.h" /* Generic Functions */
#include "H5Ipublic.h" /* Identifiers */

/* Value for the default error stack */
/** Value for the default error stack \since 1.12.2 */
#define H5E_DEFAULT 0 /* (hid_t) */

/**
Expand Down
27 changes: 17 additions & 10 deletions src/H5Fpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,31 @@
* also open the file with the #H5F_ACC_RDONLY flag. */

/**
* Default property list identifier
* Default file access
*
* \internal Value passed to H5Pset_elink_acc_flags to cause flags to be taken from the parent file.
* \internal ignore setting on lapl
* \since 1.8.3
*/
#define H5F_ACC_DEFAULT (0xffffu)

/* Flags for H5Fget_obj_count() & H5Fget_obj_ids() calls */
#define H5F_OBJ_FILE (0x0001u) /**< File objects */
#define H5F_OBJ_DATASET (0x0002u) /**< Dataset objects */
#define H5F_OBJ_GROUP (0x0004u) /**< Group objects */
#define H5F_OBJ_DATATYPE (0x0008u) /**< Datatype objects */
#define H5F_OBJ_ATTR (0x0010u) /**< Attribute objects */
#define H5F_OBJ_ALL (H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR)
#define H5F_OBJ_LOCAL \
(0x0020u) /**< Restrict search to objects opened through current file ID \
(as opposed to objects opened through any file ID accessing this file) */
#define H5F_OBJ_FILE (0x0001u) /**< File objects \since 1.6.0 */
#define H5F_OBJ_DATASET (0x0002u) /**< Dataset objects \since 1.6.0 */
#define H5F_OBJ_GROUP (0x0004u) /**< Group objects \since 1.6.0 */
#define H5F_OBJ_DATATYPE (0x0008u) /**< Datatype objects \since 1.6.0 */
#define H5F_OBJ_ATTR (0x0010u) /**< Attribute objects \since 1.6.0 */
/** All objects \since 1.6.0 */
#define H5F_OBJ_ALL (H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR)

/**
* Restrict search to objects opened through current file ID (as opposed to
* objects opened through any file ID accessing this file) \since 1.6.5 */
#define H5F_OBJ_LOCAL (0x0020u)

/**
* Default value to pass into H5Pset_fapl_family() when the size of each file
* member is unknown \since 1.8.0 */
#define H5F_FAMILY_DEFAULT 0 /* (hsize_t) */

#ifdef H5_HAVE_PARALLEL
Expand Down
23 changes: 6 additions & 17 deletions src/H5Lpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,10 @@
/* Public Macros */
/*****************/

/**
* \brief Maximum length of a link's name
*
* The maximum length of a link's name is encoded in a 32-bit unsigned integer.
*/
/** Maximum length of a link's name \since 1.8.0 */
#define H5L_MAX_LINK_NAME_LEN UINT32_MAX

/**
* \brief Macro to indicate operation occurs on same location
*/
/** Macro to indicate operation occurs on same location \since 1.8.0 */
#define H5L_SAME_LOC 0 /* (hid_t) */

#ifdef __cplusplus
Expand Down Expand Up @@ -67,17 +61,12 @@ typedef enum {
H5L_TYPE_EXTERNAL = 64, /**< External link id */
H5L_TYPE_MAX = 255 /**< Maximum link type id */
} H5L_type_t;
/**
* \brief Maximum value link value for "built-in" link types
*/

/** Maximum value link value for "built-in" link types \since 1.8.0 */
#define H5L_TYPE_BUILTIN_MAX H5L_TYPE_SOFT
/**
* \brief Link ids at or above this value are "user-defined" link types.
*/
/** Link ids at or above this value are "user-defined" link types. \since 1.8.0 */
#define H5L_TYPE_UD_MIN H5L_TYPE_EXTERNAL
/**
* \brief Maximum link id value for "user-defined" link types.
*/
/** Maximum link id value for "user-defined" link types. \since 1.12.1 */
#define H5L_TYPE_UD_MAX H5L_TYPE_MAX

/**
Expand Down
2 changes: 1 addition & 1 deletion src/H5Ppublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@
*/
#define H5P_CRT_ORDER_INDEXED 0x0002
/**
* Default value of type \ref hid_t for all property list classes
* Default value of type \ref hid_t for all property list classes \since 1.0.0
*/
#define H5P_DEFAULT 0 /* (hid_t) */

Expand Down
Loading