mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-01 12:46:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

u/var: Improve doc comments [NFC]

Browse source
This commit is contained in:
Jakob Bornecrantz 2023-06-22 16:12:59 +01:00
parent 04298976da
commit 7ef4007196
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/xrt/auxiliary/util/u_var.h
View file

@ -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 * 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 * 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. * side-effects.
* *
* This is intended only for debugging and is turned off by default, as this all * 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); * 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 * @ingroup aux_util
*/ */
void void