]> Kevux Git Server - fll/commitdiff
Cleanup: Add missing documentation on wrap_up_stop.
authorKevin Day <Kevin@kevux.org>
Sat, 22 Nov 2025 16:10:37 +0000 (10:10 -0600)
committerKevin Day <Kevin@kevux.org>
Sat, 22 Nov 2025 16:10:37 +0000 (10:10 -0600)
level_0/f_console/c/console/common.h

index 7f0e0ce8415aadd7001202b29b32110d42a3a676..84d94b269e3611e89b44338cb586f11ff5f095a8 100644 (file)
@@ -306,6 +306,8 @@ extern "C" {
  *                        Set status to F_process to perform normal operations after executing the callback.
  *                        The F_break, F_continue, and depth are not used for this type.
  *
+ *   - wrap_up_stop:      This is identical to the wrap_up, but it happens due to the stop point being reached.
+ *
  * When using the callback, then the responsibility of ensuring the proper and secure handling of the data is on in the callback.
  * Failure to properly handle this can lead to integrity and security issues.
  *