diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-07-27 19:24:05 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-27 19:24:05 (GMT) |
| commit | df5dcb2a735dd5bb3ee2cc700119109605976e41 (patch) | |
| tree | 4013a33b5e586013dce09c4831510cb59fdf400c /src/H5ESpublic.h | |
| parent | cb69bc279ce12d078d43f7aa70b2929d8df1c147 (diff) | |
| download | hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.zip hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.gz hdf5-df5dcb2a735dd5bb3ee2cc700119109605976e41.tar.bz2 | |
Normalizes the public headers (#3292)
* Also brings over the apostrophe fix
Diffstat (limited to 'src/H5ESpublic.h')
| -rw-r--r-- | src/H5ESpublic.h | 25 |
1 files changed, 14 insertions, 11 deletions
diff --git a/src/H5ESpublic.h b/src/H5ESpublic.h index f2c7cb5..b5f2af4 100644 --- a/src/H5ESpublic.h +++ b/src/H5ESpublic.h @@ -17,24 +17,27 @@ #ifndef H5ESpublic_H #define H5ESpublic_H -/* Public headers needed by this file */ -#include "H5public.h" /* Generic Functions */ +#include "H5public.h" /* Generic Functions */ +#include "H5Ipublic.h" /* Identifiers */ /*****************/ /* Public Macros */ /*****************/ -/* Default value for "no event set" / synchronous execution */ -#define H5ES_NONE 0 /* (hid_t) */ +/** + * Default value for "no event set" / synchronous execution. Used in + * place of a @ref hid_t identifier. + */ +#define H5ES_NONE 0 /* Special "wait" timeout values */ -#define H5ES_WAIT_FOREVER (UINT64_MAX) /* Wait until all operations complete */ -#define H5ES_WAIT_NONE \ - (0) /* Don't wait for operations to complete, \ - * just check their status. \ - * (this allows H5ESwait to behave \ - * like a 'test' operation) \ - */ +#define H5ES_WAIT_FOREVER (UINT64_MAX) /**< Wait until all operations complete */ + +/** + * Don't wait for operations to complete, just check their status. + * (This allows @ref H5ESwait to behave like a 'test' operation) + */ +#define H5ES_WAIT_NONE (0) /*******************/ /* Public Typedefs */ |