From 59b8b2dbaed6e165dbcbb38b4a2423e84af974f2 Mon Sep 17 00:00:00 2001
From: Rylie Pavlik <rylie.pavlik@collabora.com>
Date: Wed, 28 Aug 2024 11:43:58 -0500
Subject: [PATCH] c/util: comp_base doc improvement

Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2322>
---
 src/xrt/compositor/util/comp_base.h | 31 +++++++++++++++--------------
 1 file changed, 16 insertions(+), 15 deletions(-)

diff --git a/src/xrt/compositor/util/comp_base.h b/src/xrt/compositor/util/comp_base.h
index cff813cc7..2cea42c49 100644
--- a/src/xrt/compositor/util/comp_base.h
+++ b/src/xrt/compositor/util/comp_base.h
@@ -41,22 +41,23 @@ struct comp_frame_params
  * A simple compositor base that handles a lot of things for you.
  *
  * Things it handles for you:
- * * App swapchains
- * * App fences
- * * Vulkan bundle (needed for swapchains and fences)
- * * Layer tracking, not @ref xrt_compositor::layer_commit
- * * Wait function, not @ref xrt_compositor::predict_frame
  *
- * Functions it does not handle:
- * * @ref xrt_compositor::begin_session
- * * @ref xrt_compositor::end_session
- * * @ref xrt_compositor::predict_frame
- * * @ref xrt_compositor::mark_frame
- * * @ref xrt_compositor::begin_frame
- * * @ref xrt_compositor::discard_frame
- * * @ref xrt_compositor::layer_commit
- * * @ref xrt_compositor::poll_events
- * * @ref xrt_compositor::destroy
+ * - App swapchains
+ * - App fences
+ * - Vulkan bundle (needed for swapchains and fences)
+ * - Layer tracking, not @ref xrt_compositor::layer_commit
+ * - Wait function, not @ref xrt_compositor::predict_frame
+ *
+ * Functions it does not implement:
+ *
+ * - @ref xrt_compositor::begin_session
+ * - @ref xrt_compositor::end_session
+ * - @ref xrt_compositor::predict_frame
+ * - @ref xrt_compositor::mark_frame
+ * - @ref xrt_compositor::begin_frame
+ * - @ref xrt_compositor::discard_frame
+ * - @ref xrt_compositor::layer_commit
+ * - @ref xrt_compositor::destroy
  *
  * Partially implements @ref xrt_compositor_native, meant to serve as
  * the base of a main compositor implementation.