From: Kevin Day <Kevin@kevux.org>
Date: Thu, 10 Apr 2025 02:29:56 +0000 (-0500)
Subject: Cleanup: Add missing function documentation for fll_program_standard_signal_received_... 
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=d62fa625aad7b701de896429c0a64656db6fa741;p=fll

Cleanup: Add missing function documentation for fll_program_standard_signal_received_wait().
---

diff --git a/level_2/fll_program/c/program.h b/level_2/fll_program/c/program.h
index 4ebe6be..9a8d0a5 100644
--- a/level_2/fll_program/c/program.h
+++ b/level_2/fll_program/c/program.h
@@ -477,6 +477,8 @@ extern "C" {
  *     - signal.id:       At start and on return.
  *     - signal_received: Stores the signal received if deemed appropraite.
  *     - signal_status:   Stores the status of the signal checking function.
+ * @param max
+ *   The maximum number of consecutive failures without an interrupt from f_signal_wait() before aborting.
  *
  * @return
  *   F_interrupt on success with interrupt received.