From 276a58bd75d2ad88c08993489c256139657d74b8 Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Tue, 17 May 2022 13:53:16 -0500 Subject: [PATCH] doc: Fix doxygen warnings --- doc/conventions.md | 4 ++-- doc/writing-a-new-driver.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/conventions.md b/doc/conventions.md index 29b588002..704cb5958 100644 --- a/doc/conventions.md +++ b/doc/conventions.md @@ -114,8 +114,8 @@ the same value. For example, consider @ref client_gl_swapchain -- Its first element is named @ref client_gl_swapchain::base and is of type @ref - xrt_swapchain_gl - meaning that it implements @ref xrt_swapchain_gl +- Its first element is named @ref client_gl_swapchain::base and is of type + @ref xrt_swapchain_gl - meaning that it implements @ref xrt_swapchain_gl - @ref xrt_swapchain_gl in turn starts with @ref xrt_swapchain_gl::base which is @ref xrt_swapchain - meaning that @ref xrt_swapchain_gl **extends** @ref xrt_swapchain. (Both @ref xrt_swapchain_gl and @ref xrt_swapchain are abstract diff --git a/doc/writing-a-new-driver.md b/doc/writing-a-new-driver.md index 1f22ab4a2..fc21b7d0f 100644 --- a/doc/writing-a-new-driver.md +++ b/doc/writing-a-new-driver.md @@ -67,7 +67,7 @@ instances. Depending on whether your device can be created from a detected USB HID device, you will also need to implement either @ref xrt_auto_prober or a function -matching @ref xrt_prober_found_function_t which is the function pointer type of +matching @ref xrt_prober_found_func_t which is the function pointer type of @ref xrt_prober_entry::found. See below for more details. ## Probing @@ -79,7 +79,7 @@ or if you don't want to use the built-in HID support for some reason. If you can detect based on VID/PID, you will instead implement If you can use built-in HID, you might consider looking at @ref hdk_found, which is a nice -example of how to implement @ref xrt_prober_found_function_t to perform +example of how to implement @ref xrt_prober_found_func_t to perform detection of an HMD based on the USB HID for its IMU. Either way, your device's detection details will need to be added to a list used