summaryrefslogtreecommitdiff
path: root/quantum
diff options
context:
space:
mode:
authorFred Sundvik <fsundvik@gmail.com>2016-11-06 22:44:43 +0200
committerFred Sundvik <fsundvik@gmail.com>2016-11-06 22:44:43 +0200
commit0ba3e523a7c124e4ce54dfd043dc32e72ad3233b (patch)
tree515031fe4d93e9841296d2a1adfe64817a75e6c1 /quantum
parenta377017c95b826d83ac7a46ef176d39a58294b44 (diff)
Add documentation for the variable tracing
Diffstat (limited to 'quantum')
-rw-r--r--quantum/variable_trace.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/quantum/variable_trace.h b/quantum/variable_trace.h
index 9899816f6c..46bd827861 100644
--- a/quantum/variable_trace.h
+++ b/quantum/variable_trace.h
@@ -1,13 +1,22 @@
#ifndef VARIABLE_TRACE_H
#define VARIABLE_TRACE_H
+// For more information about the variable tracing see the readme.
+
#include "print.h"
#ifdef NUM_TRACED_VARIABLES
+// Start tracing a variable at the memory address addr
+// The name can be anything and is used only for reporting
+// The size should usually be the same size as the variable you are interested in
#define ADD_TRACED_VARIABLE(name, addr, size) \
add_traced_variable(PSTR(name), (void*)addr, size, PSTR(__FILE__), __LINE__)
+
+// Stop tracing the variable with the given name
#define REMOVE_TRACED_VARIABLE(name) remove_traced_variable(PSTR(name), PSTR(__FILE__), __LINE__)
+
+// Call to get messages when the variable has been changed
#define VERIFY_TRACED_VARIABLES() verify_traced_variables(PSTR(__FILE__), __LINE__)
#else