From 6e82dd5d0c6ff32d20cd30d42c57f91523d7a87b Mon Sep 17 00:00:00 2001 From: Leonid Yuriev Date: Sat, 10 Oct 2020 18:30:21 +0300 Subject: [PATCH] mdbx: minor refine description of `mdbx_env_delete()`. Change-Id: I095c741fba08b08c6302116d9601438d813524a1 --- mdbx.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/mdbx.h b/mdbx.h index de540016..e4bd7305 100644 --- a/mdbx.h +++ b/mdbx.h @@ -1801,7 +1801,7 @@ LIBMDBX_API int mdbx_env_create(MDBX_env **penv); LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode); -/** \brief Deletion modes for \ref mdbx_env_delete() +/** \brief Deletion modes for \ref mdbx_env_delete(). * \ingroup c_extra * \see mdbx_env_delete() */ enum MDBX_env_delete_mode_t { @@ -1812,10 +1812,11 @@ enum MDBX_env_delete_mode_t { * because the system does not support deleting files that are currently * memory mapped. */ MDBX_ENV_JUST_DELETE = 0, - /** Make sure that the environment is not being used by other processes, - * or return an error otherwise. */ + /** \brief Make sure that the environment is not being used by other + * processes, or return an error otherwise. */ MDBX_ENV_ENSURE_UNUSED = 1, - /** Wait until other processes closes the environment before deletion. */ + /** \brief Wait until other processes closes the environment before deletion. + */ MDBX_ENV_WAIT_FOR_UNUSED = 2, }; #ifndef __cplusplus @@ -1823,7 +1824,7 @@ enum MDBX_env_delete_mode_t { typedef enum MDBX_env_delete_mode_t MDBX_env_delete_mode_t; #endif -/** \brief Delete the environment files in a proper and multiprocess-safe way. +/** \brief Delete the environment's files in a proper and multiprocess-safe way. * \ingroup c_extra * * \param [in] pathname The pathname for the database or the directory in which