summaryrefslogtreecommitdiff
path: root/include/tinyff/dbg.h
diff options
context:
space:
mode:
authorTazyFoundSoup <gardendistrict0x0@outlook.com>2026-06-08 10:24:03 +1000
committerTazyFoundSoup <gardendistrict0x0@outlook.com>2026-06-08 10:24:03 +1000
commitc9f5da1d19e6ace5d6a7c650fe996f359e11d1a5 (patch)
treec5d61055549f1819d902e567f7227e0c3778300c /include/tinyff/dbg.h
parent62cbefa6a8fca583c6f600f1d7e24f0c61c91b1e (diff)
docs(headers): Clean up comments across public headers
Diffstat (limited to 'include/tinyff/dbg.h')
-rw-r--r--include/tinyff/dbg.h7
1 files changed, 2 insertions, 5 deletions
diff --git a/include/tinyff/dbg.h b/include/tinyff/dbg.h
index 379e6ce..74a5fbb 100644
--- a/include/tinyff/dbg.h
+++ b/include/tinyff/dbg.h
@@ -1,11 +1,8 @@
#ifndef DBG_H
#define DBG_H
-// Debug writes extra messages to a stream of the user's choice
-// To enable debug, the user needs to include this header
-// Then they can use the ff_set_debug_stream function to set the stream
-// And then use ff_dprintf to print debug messages
-// By default, debug is disabled
+// Debug logging writes to a user-supplied stream.
+// By default debug is disabled. Enable via ff_set_debug_stream.
#define FF_DEBUG_ENABLED 1