mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-29 11:06:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Fix doxygen warnings

Browse source
This commit is contained in:
Ryan Pavlik 2022-05-17 13:53:16 -05:00
parent df413a3809
commit 276a58bd75
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/conventions.md
View file

@ -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

4
doc/writing-a-new-driver.md
View file

@ -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