From b6cbf5199b0d3640c243dc88b2c99a30c8b2a444 Mon Sep 17 00:00:00 2001 From: ADAM David Alan Martin Date: Sun, 15 Oct 2023 03:37:12 -0400 Subject: [PATCH] Clean up some exceptions doc. --- Exception.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Exception.h b/Exception.h index 97f72a7..fea7900 100644 --- a/Exception.h +++ b/Exception.h @@ -36,7 +36,7 @@ namespace Alepha::Hydrogen * This exception can be thrown as part of normal program operation -- it is a control * flow device. * - * * `Notification`: When a thread is cancelled using interrupts, all `Exception`s thrown + * * `Notification`: When a thread is interrupted as a notification, all `Exception`s thrown * to do so are derived from this type. Alepha threads are setup to catch and discard * `Exception`s of this grade in the thread start function. It is legal to catch `Exception`s * of this type type and silence it; however, `Notification` typically means that the @@ -65,7 +65,8 @@ namespace Alepha::Hydrogen * state corruption. A program probably SHOULD ignore these and allow a core dump to * be emitted. An example of this might be: Runtime detection of dereference of a * raw pointer set to `nullptr`. This would typically indicate some kind of program - * bug. `Violation::~Violation` is setup to call `abort()` when called. + * bug. `Violation::~Violation` is setup to call `abort()` when called. In some sense + * this type is what `std::logic_error` is often used to represent. */ template< typename ... Bases >