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

a/util: Improve docs structure

Browse source
This commit is contained in:
Ryan Pavlik 2022-05-18 10:31:57 -05:00
parent 3de4488dfd
commit 588b4831a2
3 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/xrt/auxiliary/util/u_distortion.h
View file

@ -20,7 +20,7 @@ extern "C" {
struct xrt_hmd_parts; struct xrt_hmd_parts;
/*! /*!
* @defgroup aux_distortion Distortion utilities. * @defgroup aux_distortion Distortion utilities
* @ingroup aux_util * @ingroup aux_util
*/ */

2
src/xrt/auxiliary/util/u_logging.h
View file

@ -24,7 +24,7 @@ struct xrt_device;
/*! /*!
* @defgroup aux_log Logging functions. * @defgroup aux_log Logging functions
* @ingroup aux_util * @ingroup aux_util
*/ */

13
src/xrt/auxiliary/util/u_pretty_print.h
View file

@ -16,10 +16,11 @@ extern "C" {
/*! /*!
* @defgroup aux_pretty Pretty printing functions. * @defgroup aux_pretty Pretty printing functions and helpers
* @ingroup aux_util
* *
* Multiple modules implement additional pretty printing functions like * This is common functionality used directly and shared by additional pretty
* @ref oxr_api. * printing functions implemented in multiple modules, such as @ref oxr_api.
* *
* Some functions have a `_indented` suffix added to them, this means that what * Some functions have a `_indented` suffix added to them, this means that what
* they print starts indented, but also they start with a newline. This is so * they print starts indented, but also they start with a newline. This is so
@ -29,8 +30,10 @@ extern "C" {
*/ */
/*! /*!
* Function prototype for receiving pretty printed strings, do not keep a * Function prototype for receiving pretty printed strings.
* reference to the pointer as it's often allocated on the stack for speed. *
* @note Do not keep a reference to the pointer as it's often allocated on the
* stack for speed.
* *
* @ingroup aux_pretty * @ingroup aux_pretty
*/ */