summaryrefslogtreecommitdiff
path: root/allocate.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2020-12-07 23:35:10 -0500
committerJeffrey Walton <noloader@gmail.com>2020-12-07 23:35:10 -0500
commitac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb (patch)
treea0f63ebf397db67a1d8f7e41f2e4e89d03a57a4f /allocate.h
parent4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff)
downloadcryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz
Use \return and \throw consitently in the docs
Diffstat (limited to 'allocate.h')
-rw-r--r--allocate.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/allocate.h b/allocate.h
index cf056f9f..d9fe9c57 100644
--- a/allocate.h
+++ b/allocate.h
@@ -16,7 +16,7 @@
NAMESPACE_BEGIN(CryptoPP)
/// \brief Attempts to reclaim unused memory
-/// \throws bad_alloc
+/// \throw bad_alloc
/// \details In the normal course of running a program, a request for memory
/// normally succeeds. If a call to AlignedAllocate or UnalignedAllocate fails,
/// then CallNewHandler is called in n effort to recover. Internally,
@@ -24,7 +24,7 @@ NAMESPACE_BEGIN(CryptoPP)
/// There is no guarantee CallNewHandler will be able to obtain more memory so
/// an allocation succeeds. If the call to set_new_handler fails, then CallNewHandler
/// throws a bad_alloc exception.
-/// \throws bad_alloc on failure
+/// \throw bad_alloc on failure
/// \since Crypto++ 5.0
/// \sa AlignedAllocate, AlignedDeallocate, UnalignedAllocate, UnalignedDeallocate
CRYPTOPP_DLL void CRYPTOPP_API CallNewHandler();