mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-02-05 21:38:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

xrt: Fix documentation warnings

Browse source 
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2237>
This commit is contained in:
Rylie Pavlik 2024-04-08 16:17:35 -05:00 committed by Marge Bot
parent 23115015fc
commit bc916e0f36
3 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/xrt/include/xrt/xrt_compositor.h
View file

@ -1206,7 +1206,7 @@ struct xrt_compositor
*
* @param xc Self pointer
* @param xdev The device the layer is relative to.
* @param xsc Swapchain object containing eye RGB data.
* @param xsc Array of swapchain objects containing eye RGB data.
* @param data All of the pure data bits (not pointers/handles),
* including what parts of the supplied swapchain
* objects to use for each view.
@ -1227,10 +1227,8 @@ struct xrt_compositor
*
* @param xc Self pointer
* @param xdev The device the layer is relative to.
* @param l_xsc Swapchain object containing left eye RGB data.
* @param r_xsc Swapchain object containing right eye RGB data.
* @param l_d_xsc Swapchain object containing left eye depth data.
* @param r_d_xsc Swapchain object containing right eye depth data.
* @param xsc Array of swapchain objects containing eye RGB data.
* @param d_xsc Array of swapchain objects containing eye depth data.
* @param data All of the pure data bits (not pointers/handles),
* including what parts of the supplied swapchain
* objects to use for each view.
@ -1343,7 +1341,6 @@ struct xrt_compositor
*
* Only after this call will the compositor actually use the layers.
* @param xc Self pointer
* @param frame_id The frame id this commit is for.
* @param xcsem Semaphore that will be signalled when the app GPU
* work has completed.
* @param value Semaphore value upone completion of GPU work.

2
src/xrt/include/xrt/xrt_session.h
View file

@ -279,7 +279,7 @@ xrt_session_poll_events(struct xrt_session *xs, union xrt_session_event *out_xse
/*!
* Destroy an xrt_session - helper function.
*
* @param[in,out] xsd_ptr A pointer to the xrt_session struct pointer.
* @param[in,out] xs_ptr A pointer to the xrt_session struct pointer.
*
* Will destroy the system if `*xs_ptr` is not NULL. Will then set `*xs_ptr` to
* NULL.

2
src/xrt/include/xrt/xrt_system.h
View file

@ -105,7 +105,7 @@ xrt_system_create_session(struct xrt_system *xsys,
/*!
* Destroy an xrt_system - helper function.
*
* @param[in,out] xsysd_ptr A pointer to the xrt_system struct pointer.
* @param[in,out] xsys_ptr A pointer to the xrt_system struct pointer.
*
* Will destroy the system if `*xsys_ptr` is not NULL. Will then set
* `*xsys_ptr` to NULL.