From afa8469f836d2e00855dacd8d3705f7b12516b61 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Mon, 30 Jun 2025 21:51:33 -0500 Subject: [PATCH] Cleanup: Documentation comments for program signal handlers. The function references and "must not be NULL" messages are missing. --- sources/c/program/controller/main/signal.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/sources/c/program/controller/main/signal.h b/sources/c/program/controller/main/signal.h index 1c029ab..d310a10 100644 --- a/sources/c/program/controller/main/signal.h +++ b/sources/c/program/controller/main/signal.h @@ -33,15 +33,16 @@ extern "C" { * @param main * The main program and settings data. * + * Must not be NULL. + * * This alters main.program.signal_received, setting it to a received signal. + * This alters main.program.signal_status. * - * This alters main.setting.state.status: - * Errors (with error bit) from: f_signal_open() - * Errors (with error bit) from: f_signal_wait() + * This does not alter main.setting.state.status. * - * @see f_signal_close() - * @see f_signal_open() - * @see f_signal_wait() + * @see f_signal_set_add() + * @see f_signal_set_empty() + * @see fll_program_standard_signal_received_wait() */ #if !defined(_di_controller_signal_handler_) && !defined(_di_thread_support_) extern void controller_signal_handler(controller_t * const main); -- 1.8.3.1