From c19b832a6b660c00def4313c8fa8333344e837df Mon Sep 17 00:00:00 2001 From: Jeremy Lorelli Date: Thu, 2 Jul 2026 19:01:55 -0700 Subject: [PATCH] libcom: Update doc comment for cantProceed --- modules/libcom/src/misc/cantProceed.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/libcom/src/misc/cantProceed.h b/modules/libcom/src/misc/cantProceed.h index 910ace1fe..82cb4af64 100644 --- a/modules/libcom/src/misc/cantProceed.h +++ b/modules/libcom/src/misc/cantProceed.h @@ -34,12 +34,14 @@ extern "C" { #endif -/** \brief Suspend this thread, the caller cannot continue or return. +/** \brief Suspend this thread or call abort(), the caller cannot continue + * or return. * * The effect of calling this is to print the error message followed by - * the name of the thread that is being suspended. A stack trace will + * the name of the thread that can't proceed. A stack trace will * also be shown if supported by the OS, and the thread is suspended - * inside an infinite loop. + * inside an infinite loop, or the process aborted, depending on + * EPICS_ABORT_ON_ASSERT. * \param errorMessage A printf-style error message describing the error. * \param ... Any parameters required for the error message. */