changeset 376:b75fa5f47bf0

doc: document presence of (panic|trace)_data
author David Demelier <markand@malikania.fr>
date Tue, 02 Nov 2021 15:35:53 +0100
parents d83b686dcf63
children bc01bb8ee870
files doc/docs/dev/api/core/panic.md doc/docs/dev/api/core/trace.md
diffstat 2 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/docs/dev/api/core/panic.md	Tue Nov 02 15:22:14 2021 +0100
+++ b/doc/docs/dev/api/core/panic.md	Tue Nov 02 15:35:53 2021 +0100
@@ -26,6 +26,7 @@
 | Variable                        | Type             |
 |---------------------------------|------------------|
 | [panic_handler](#panic_handler) | `void (*)(void)` |
+| [panic_data](#panic_data)       | `void *`         |
 
 ### panic\_handler
 
@@ -38,6 +39,10 @@
 If the user defined function returns, panic routines will finally exit with code
 1.
 
+### panic\_data
+
+Placeholder data for the handler if needed.
+
 ## Functions
 
 ### panicf
--- a/doc/docs/dev/api/core/trace.md	Tue Nov 02 15:22:14 2021 +0100
+++ b/doc/docs/dev/api/core/trace.md	Tue Nov 02 15:35:53 2021 +0100
@@ -20,11 +20,16 @@
 | Variable                        | Type                     |
 |---------------------------------|--------------------------|
 | [trace_handler](#trace_handler) | `void (*)(const char *)` |
+| [trace_data](#trace_data)       | `void *`                 |
 
 ### trace\_handler
 
 The default one use a simple printf on the standard output.
 
+### trace\_data
+
+Placeholder data for the handler if needed.
+
 ## Macros
 
 ### TRACE\_LINE\_MAX