From bbb8bb939a24fa7625b5f8c97d610159e164b2ae Mon Sep 17 00:00:00 2001 From: David Boucher Date: Wed, 4 Jan 2023 16:20:44 +0100 Subject: [PATCH] clean(engine): new comment added --- engine/src/notifier.cc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/engine/src/notifier.cc b/engine/src/notifier.cc index ebcd81b00f5..3a2bc547bcb 100644 --- a/engine/src/notifier.cc +++ b/engine/src/notifier.cc @@ -1225,6 +1225,12 @@ void notifier::set_check_options(int option) noexcept { _check_options = option; } +/** + * @brief Tell if an acknowledgement is active on the notifier by returning its + * type ACK_NONE (no acknowledgement), ACK_NORMAL or ACK_STICKY. + * + * @return A notifier::acknowledgement_type. + */ notifier::acknowledgement_type notifier::get_acknowledgement() const noexcept { return _acknowledgement_type; }