diff options
author | Gereon Kremer <gereon.kremer@cs.rwth-aachen.de> | 2021-04-14 22:35:07 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-14 20:35:07 +0000 |
commit | 485b3db20d182b0d621c002bb355c9d1ec2429e9 (patch) | |
tree | 0796088bfe4b70055c298fa6a3d13f246c403ea2 /docs/cpp | |
parent | 9f14a0d6feca8d8ba727f88ef7dda5268183bb56 (diff) |
Improve documentation for API exceptions (#6340)
Diffstat (limited to 'docs/cpp')
-rw-r--r-- | docs/cpp/exceptions.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/cpp/exceptions.rst b/docs/cpp/exceptions.rst new file mode 100644 index 000000000..93a680533 --- /dev/null +++ b/docs/cpp/exceptions.rst @@ -0,0 +1,27 @@ +Exceptions +========== + +The CVC5 API communicates certain errors using exceptions. We broadly +distinguish two types of exceptions: :cpp:class:`CVC4ApiException +<cvc5::api::CVC4ApiException>` and :cpp:class:`CVC4ApiRecoverableException +<cvc5::api::CVC4ApiRecoverableException>` (which is derived from +:cpp:class:`CVC4ApiException <cvc5::api::CVC4ApiException>`). + +If any method fails with a :cpp:class:`CVC4ApiRecoverableException +<cvc5::api::CVC4ApiRecoverableException>`, the solver behaves as if the failing +method was not called. The solver can still be used safely. + +If, however, a method fails with a :cpp:class:`CVC4ApiException +<cvc5::api::CVC4ApiException>`, the associated object may be in an unsafe state +and it should no longer be used. + + +.. doxygenclass:: cvc5::api::CVC4ApiException + :project: cvc5 + :members: + :undoc-members: + +.. doxygenclass:: cvc5::api::CVC4ApiRecoverableException + :project: cvc5 + :members: + :undoc-members: |