Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit 8fc76b5

Browse files
committed
[doxygen] extend exceptions descriptions
1 parent 790420b commit 8fc76b5

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

include/libpmemobj++/pexceptions.hpp

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ exception_with_errormsg(Args &&... args)
7878
* Custom pool error class.
7979
*
8080
* Thrown when there is a runtime problem with some action on the
81-
* pool.
81+
* pool, e.g., object wasn't in a pool, invalid pool handle, etc.
8282
* @ingroup exceptions
8383
*/
8484
class pool_error : public std::runtime_error {
@@ -90,6 +90,8 @@ class pool_error : public std::runtime_error {
9090
* Custom pool error class.
9191
*
9292
* Thrown when there is an invalid argument passed to create/open pool.
93+
* Specialization of pool_error, which is thrown
94+
* when creating/opening pool failed.
9395
* @ingroup exceptions
9496
*/
9597
class pool_invalid_argument : public pool_error {
@@ -100,7 +102,8 @@ class pool_invalid_argument : public pool_error {
100102
/**
101103
* Custom transaction error class.
102104
*
103-
* Thrown when there is a runtime problem with a transaction.
105+
* Thrown when there is a runtime problem with a transaction, e.g.,
106+
* when the transaction is in the wrong stage, or on transaction abort.
104107
* @ingroup exceptions
105108
*/
106109
class transaction_error : public std::runtime_error {

0 commit comments

Comments
 (0)