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

a/tracking: Fix doxygen warnings about invalid link requests

Browse source
This commit is contained in:
Ryan Pavlik 2021-11-03 17:13:38 -05:00
parent ebde5344a1
commit 86c7a27156
3 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.cpp
View file

@ -2,7 +2,7 @@
// SPDX-License-Identifier: BSL-1.0
/*!
* @file
* @brief Simple @ref xrt_frame wrapper around a @ref cv::Mat.
* @brief Simple @ref xrt_frame wrapper around a cv::Mat.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup aux_tracking
*/

20
src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp
View file

@ -2,7 +2,7 @@
// SPDX-License-Identifier: BSL-1.0
/*!
* @file
* @brief Simple @ref xrt_frame wrapper around a @ref cv::Mat.
* @brief Simple @ref xrt_frame wrapper around a cv::Mat.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup aux_tracking
*/
@ -33,7 +33,7 @@ public:
// Exposed to the C api.
struct xrt_frame frame = {};
// The @ref cv::Mat that holds the data.
// The cv::Mat that holds the data.
cv::Mat matrix = cv::Mat();
@ -44,22 +44,22 @@ public:
~FrameMat();
/*!
* Wraps the given @ref cv::Mat assuming it's a 24bit RGB format matrix.
* Wraps the given cv::Mat assuming it's a 24bit RGB format matrix.
* In all but the most strange cases you probably want the pointer
* pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have
* it's reference decremented so make sure it's a valid pointer.
* pointed to by @p xf_ptr to be `nullptr`, if not `nullptr` it will have
* its reference count decremented so make sure it's a valid pointer.
*/
static void
wrapR8G8B8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {});
wrapR8G8B8(cv::Mat mat, xrt_frame **xf_ptr, const Params params = {});
/*!
* Wraps the given @ref cv::Mat assuming it's a 8bit format matrix.
* Wraps the given cv::Mat assuming it's a 8bit format matrix.
* In all but the most strange cases you probably want the pointer
* pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have
* it's reference decremented so make sure it's a valid pointer.
* pointed to by @p xf_ptr to be `nullptr`, if not `nullptr` it will have
* its reference count decremented so make sure it's a valid pointer.
*/
static void
wrapL8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {});
wrapL8(cv::Mat mat, xrt_frame **xf_ptr, const Params params = {});
private:

3
src/xrt/auxiliary/tracking/t_tracking.h
View file

@ -99,7 +99,8 @@ struct t_stereo_camera_calibration
/*!
* Allocates a new stereo calibration data, unreferences the old @p calib.
*
* Also initializes view[s]::distortion_num, only 5 and 14 is accepted.
* Also initializes t_camera_calibration::distortion_num in t_stereo_camera_calibration::view, only 5 and 14 is
* accepted.
*
* @public @memberof t_stereo_camera_calibration
*/