From 4c5327fc65b0db84f9d2d797edca43aac1dee187 Mon Sep 17 00:00:00 2001 From: Ryan Pavlik <ryan.pavlik@collabora.com> Date: Fri, 15 Jul 2022 12:50:04 -0500 Subject: [PATCH] xrt: Improve code docs --- src/xrt/include/xrt/xrt_compositor.h | 5 +++-- src/xrt/include/xrt/xrt_settings.h | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/xrt/include/xrt/xrt_compositor.h b/src/xrt/include/xrt/xrt_compositor.h index 86866ac78..659cf84f9 100644 --- a/src/xrt/include/xrt/xrt_compositor.h +++ b/src/xrt/include/xrt/xrt_compositor.h @@ -1831,6 +1831,7 @@ struct xrt_system_compositor_info struct xrt_system_compositor; /*! + * @interface xrt_multi_compositor_control * Special functions to control multi session/clients. */ struct xrt_multi_compositor_control @@ -1881,8 +1882,8 @@ struct xrt_system_compositor * This signals that you want to start XR, and as such implicitly brings * up a new session. Does not "call" `xrBeginSession`. * - * Some system compositors might only support that one `xrt_compositor` - * is always at a time, will return `XRT_ERROR_MULTI_SESSION_NOT_IMPLEMENTED` + * Some system compositors might only support that one `xrt_compositor` + * is active at a time, will return `XRT_ERROR_MULTI_SESSION_NOT_IMPLEMENTED` * if this is the case. */ xrt_result_t (*create_native_compositor)(struct xrt_system_compositor *xsc, diff --git a/src/xrt/include/xrt/xrt_settings.h b/src/xrt/include/xrt/xrt_settings.h index bcd8301f0..88ed5206c 100644 --- a/src/xrt/include/xrt/xrt_settings.h +++ b/src/xrt/include/xrt/xrt_settings.h @@ -3,7 +3,7 @@ /*! * @file * @brief Common settings structs to be transferred between different parts of - * Monadon. + * Monado, mainly for tracking and camera usage. * @author Jakob Bornecrantz <jakob@collabora.com> * @ingroup xrt_iface */