From e85faec8d54950324beff1bff21ca6dbb3e1518c Mon Sep 17 00:00:00 2001 From: Rylie Pavlik Date: Fri, 8 Dec 2023 12:48:15 -0600 Subject: [PATCH] c/main: Improve docs for comp_compositor --- src/xrt/compositor/main/comp_compositor.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/xrt/compositor/main/comp_compositor.h b/src/xrt/compositor/main/comp_compositor.h index 51682f2cb..3f28233ba 100644 --- a/src/xrt/compositor/main/comp_compositor.h +++ b/src/xrt/compositor/main/comp_compositor.h @@ -89,8 +89,14 @@ struct comp_frame /*! * Main compositor struct tying everything in the compositor together. * + * + * This ultimately implements @ref xrt_compositor_native but does so by + * extending @ref comp_base. Yes, it looks like a little bit of "code reuse + * through inheritance," but it is useful here to avoid lots of boilerplate + * due to the use of C. + * * @ingroup comp_main - * @implements xrt_compositor_native + * @extends comp_base */ struct comp_compositor {