From 7ef4007196dac76b766265c657ce3b46347ab0be Mon Sep 17 00:00:00 2001 From: Jakob Bornecrantz Date: Thu, 22 Jun 2023 16:12:59 +0100 Subject: [PATCH] u/var: Improve doc comments [NFC] --- src/xrt/auxiliary/util/u_var.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/xrt/auxiliary/util/u_var.h b/src/xrt/auxiliary/util/u_var.h index afbae94b7..417ea3172 100644 --- a/src/xrt/auxiliary/util/u_var.h +++ b/src/xrt/auxiliary/util/u_var.h @@ -293,7 +293,7 @@ typedef void (*u_var_elm_cb)(struct u_var_info *info, void *); /*! * Add a named root object, the u_var subsystem is completely none-invasive * to the object it's tracking. The root pointer is used as a entry into a - * hashmap of hidden objecrs. When not active all calls are stubs and have no + * hashmap of hidden objects. When not active all calls are stubs and have no * side-effects. * * This is intended only for debugging and is turned off by default, as this all @@ -314,6 +314,10 @@ typedef void (*u_var_elm_cb)(struct u_var_info *info, void *); * u_var_remove_root((void*)psmv); * ``` * + * @param root Object to be tracked. + * @param c_name Name of object, null terminated "C" string. + * @param suffix_with_number Should name be suffixed with a number. + * * @ingroup aux_util */ void