diff --git a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.cpp b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.cpp index 122ca51be..4e733bb6b 100644 --- a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.cpp +++ b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.cpp @@ -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 * @ingroup aux_tracking */ diff --git a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp index f459406b1..c841a60d3 100644 --- a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp +++ b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp @@ -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 * @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: diff --git a/src/xrt/auxiliary/tracking/t_tracking.h b/src/xrt/auxiliary/tracking/t_tracking.h index 62dc46def..d9523551e 100644 --- a/src/xrt/auxiliary/tracking/t_tracking.h +++ b/src/xrt/auxiliary/tracking/t_tracking.h @@ -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 */