From a8f49231d36df29c7b89e1db37caddeb6ef50e3a Mon Sep 17 00:00:00 2001 From: Dana Robinson Date: Sat, 2 Sep 2023 23:24:01 -0700 Subject: [PATCH] Add deprecation notice for hbool_t --- src/H5public.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/H5public.h b/src/H5public.h index ca440c08b20..8fce3f47dba 100644 --- a/src/H5public.h +++ b/src/H5public.h @@ -237,6 +237,12 @@ typedef int herr_t; /** * C99-style Boolean type. Successful return values are zero (false) or positive * (true). The typical true value is 1 but don't bet on it. + * + * \deprecated Now that we require C99, hbool_t is typedef'd to C99's bool + * and hbool_t is considered deprecated. Due to its long-standing, + * widespread use, we have no plans to remove the hbool_t typedef + * from the public API, though we will probably switch to using + * bool in the public API starting in the next major release of HDF5. * \attention Boolean functions cannot fail. */ #include