Skip to content
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
14 changes: 6 additions & 8 deletions src/H5Fpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@
* member is unknown \since 1.8.0 */
#define H5F_FAMILY_DEFAULT 0 /* (hsize_t) */

/* Macro used to "unset" the page buffer size in a FAPL */
/** Macro used to "unset" the page buffer size in a FAPL \since 2.0.0 */
#define H5F_PAGE_BUFFER_SIZE_DEFAULT SIZE_MAX

#ifdef H5_HAVE_PARALLEL
/**
* Use this constant string as the MPI_Info key to set H5Fmpio debug flags.
* To turn on H5Fmpio debug flags, set the MPI_Info value with this key to
* have the value of a string consisting of the characters that turn on the
* desired flags.
* desired flags. \since 1.0.0
*/
#define H5F_MPIO_DEBUG_KEY "H5F_mpio_debug_key"
#endif /* H5_HAVE_PARALLEL */
Expand All @@ -100,9 +100,7 @@ typedef enum H5F_scope_t {
H5F_SCOPE_GLOBAL = 1 /**< The entire virtual file */
} H5F_scope_t;

/**
* Unlimited file size for H5Pset_external()
*/
/** Unlimited file size for H5Pset_external() \since 1.0.0 */
#define H5F_UNLIMITED HSIZE_UNDEF

/**
Expand Down Expand Up @@ -248,13 +246,13 @@ typedef herr_t (*H5F_flush_cb_t)(hid_t object_id, void *udata);
/**
* Suppress errors for numeric datatypes with an unusually high number of
* unused bits. See documentation for H5Pset_relax_file_integrity_checks()
* for details.
* for details. \since 1.14.4
*/
#define H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS (0x0001u)

/**
* Suppress all format integrity check errors. See documentation for
* H5Pset_relax_file_integrity_checks() for details.
* H5Pset_relax_file_integrity_checks() for details. \since 1.14.4
*/
#define H5F_RFIC_ALL (H5F_RFIC_UNUSUAL_NUM_UNUSED_NUMERIC_BITS)

Expand Down Expand Up @@ -1907,7 +1905,7 @@ H5_DLL herr_t H5Fformat_convert(hid_t fid);
#ifndef H5_NO_DEPRECATED_SYMBOLS

/* Macros */
#define H5F_ACC_DEBUG (0x0000u) /**< Print debug info \deprecated In which version? */
#define H5F_ACC_DEBUG (0x0000u) /**< Print debug info \deprecated 1.8.16 */

/* Typedefs */

Expand Down
19 changes: 10 additions & 9 deletions src/H5Gpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -524,17 +524,18 @@ H5_DLL herr_t H5Gclose_async(hid_t group_id, hid_t es_id);
/* Macros */

/* Link definitions */
#define H5G_SAME_LOC H5L_SAME_LOC
#define H5G_LINK_ERROR H5L_TYPE_ERROR
#define H5G_LINK_HARD H5L_TYPE_HARD
#define H5G_LINK_SOFT H5L_TYPE_SOFT
#define H5G_link_t H5L_type_t
#define H5G_SAME_LOC H5L_SAME_LOC /**< Indicates operation occurs on same location \since 1.6.0 */
#define H5G_LINK_ERROR H5L_TYPE_ERROR /**< Invalid link type id \since 1.8.0 */
#define H5G_LINK_HARD H5L_TYPE_HARD /**< Hard link id \since 1.8.0 */
#define H5G_LINK_SOFT H5L_TYPE_SOFT /**< Soft link id \since 1.8.0 */
#define H5G_link_t H5L_type_t /**< Link types \since 1.0.0 */

/* Macros for types of objects in a group (see H5G_obj_t definition) */
#define H5G_NTYPES 256 /* Max possible number of types */
#define H5G_NLIBTYPES 8 /* Number of internal types */
#define H5G_NUSERTYPES (H5G_NTYPES - H5G_NLIBTYPES)
#define H5G_USERTYPE(X) (8 + (X)) /* User defined types */
#define H5G_NTYPES 256 /**< Max possible number of types \since 1.0.0 */
#define H5G_NLIBTYPES 8 /**< Number of internal types \since 1.2.0 */
#define H5G_NUSERTYPES (H5G_NTYPES - H5G_NLIBTYPES)
/**< Number of user-defined types \since 1.2.0 */
#define H5G_USERTYPE(X) (8 + (X)) /**< User defined types \since 1.2.0 */

/* Typedefs */

Expand Down
8 changes: 2 additions & 6 deletions src/H5Ipublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,10 @@ typedef int64_t hid_t;
#define PRIXHID PRIX64
#define PRIoHID PRIo64

/**
* The size of identifiers
*/
/** The size of identifiers \since 1.8.0 */
#define H5_SIZEOF_HID_T H5_SIZEOF_INT64_T

/**
* An invalid object ID. This is also negative for error return.
*/
/** An invalid object ID. This is also negative for error return. \since 1.6.0 */
#define H5I_INVALID_HID (-1)

/**
Expand Down
14 changes: 4 additions & 10 deletions src/H5PLpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,10 @@ typedef enum H5PL_type_t {
//! <!-- [H5PL_type_t_snip] -->

/* Common dynamic plugin type flags used by the set/get_loading_state functions */
/** Flag for filter plugin \since 1.8.15 */
#define H5PL_FILTER_PLUGIN 0x0001
/** Flag for VOL plugin \since 1.12.0 */
#define H5PL_VOL_PLUGIN 0x0002
/** Flag for VFD plugin \since 1.14.0 */
#define H5PL_VFD_PLUGIN 0x0004
/** Flag for all plugin types \since 1.8.15 */
#define H5PL_ALL_PLUGIN 0xFFFF

#define H5F_ACC_DEBUG (0x0000u) /**< Print debug info \deprecated In which version? */
#define H5PL_FILTER_PLUGIN 0x0001 /**< Flag for filter plugin \since 1.8.15 */
#define H5PL_VOL_PLUGIN 0x0002 /**< Flag for VOL plugin \since 1.12.0 */
#define H5PL_VFD_PLUGIN 0x0004 /**< Flag for VFD plugin \since 1.14.0 */
#define H5PL_ALL_PLUGIN 0xFFFF /**< Flag for all plugin types \since 1.8.15 */

#ifdef __cplusplus
extern "C" {
Expand Down
2 changes: 1 addition & 1 deletion src/H5Rpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#define H5R_DSET_REG_REF_BUF_SIZE (sizeof(haddr_t) + 4)

/**
* Default reference buffer size.
* Default reference buffer size. \since 1.12.0
*
* \internal Note! Be careful with the sizes of the references because they
* should really depend on the run-time values in the file.
Expand Down