From b93b082bd38fd54c0ff8810465de7aab6f5dcff2 Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Fri, 26 Mar 2021 11:21:00 -0500 Subject: [PATCH] aux: Fix doxygen warnings --- src/xrt/auxiliary/math/m_api.h | 16 +++++----- src/xrt/auxiliary/os/os_hid.h | 4 +-- src/xrt/auxiliary/tracking/t_tracking.h | 12 ++++---- src/xrt/auxiliary/util/u_sink.h | 39 ++++++++++++------------- 4 files changed, 34 insertions(+), 37 deletions(-) diff --git a/src/xrt/auxiliary/math/m_api.h b/src/xrt/auxiliary/math/m_api.h index 2369e6d83..d3483a61a 100644 --- a/src/xrt/auxiliary/math/m_api.h +++ b/src/xrt/auxiliary/math/m_api.h @@ -147,7 +147,7 @@ math_vec3_normalize(struct xrt_vec3 *in); * Create a rotation from a angle in radians and a vector. * * @relates xrt_quat - * @relates xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -157,7 +157,7 @@ math_quat_from_angle_vector(float angle_rads, const struct xrt_vec3 *vector, str * Create a rotation from a 3x3 rotation matrix. * * @relates xrt_quat - * @relates xrt_matrix_3x3 + * @see xrt_matrix_3x3 * @ingroup aux_math */ void @@ -168,7 +168,7 @@ math_quat_from_matrix_3x3(const struct xrt_matrix_3x3 *mat, struct xrt_quat *res * matrix by crossing z and x to get the y axis. * * @relates xrt_quat - * @relates xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -226,7 +226,7 @@ math_quat_ensure_normalized(struct xrt_quat *inout); * Rotate a vector. * * @relates xrt_quat - * @relatesalso xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -250,7 +250,7 @@ math_quat_rotate(const struct xrt_quat *left, const struct xrt_quat *right, stru * vector should be in radians per unit of time. * * @relates xrt_quat - * @relatesalso xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -269,7 +269,7 @@ math_quat_integrate_velocity(const struct xrt_quat *quat, * radians per unit of time. * * @relates xrt_quat - * @relatesalso xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -282,7 +282,7 @@ math_quat_finite_difference(const struct xrt_quat *quat0, * Used to rotate a derivative like a angular velocity. * * @relates xrt_quat - * @relatesalso xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void @@ -404,7 +404,7 @@ math_pose_transform(const struct xrt_pose *transform, const struct xrt_pose *pos * The input point and output may be the same pointer. * * @relates xrt_pose - * @relates xrt_vec3 + * @see xrt_vec3 * @ingroup aux_math */ void diff --git a/src/xrt/auxiliary/os/os_hid.h b/src/xrt/auxiliary/os/os_hid.h index 146463c09..f30146879 100644 --- a/src/xrt/auxiliary/os/os_hid.h +++ b/src/xrt/auxiliary/os/os_hid.h @@ -136,8 +136,8 @@ os_hid_destroy(struct os_hid_device *hid_dev) /*! * Open the given path as a hidraw device. * - * @public @memberof hid_hidraw - * @relatesalso os_hid_device + * @see hid_hidraw + * @public @memberof os_hid_device */ int os_hid_open_hidraw(const char *path, struct os_hid_device **out_hid); diff --git a/src/xrt/auxiliary/tracking/t_tracking.h b/src/xrt/auxiliary/tracking/t_tracking.h index 3e97ce19b..15a16e06b 100644 --- a/src/xrt/auxiliary/tracking/t_tracking.h +++ b/src/xrt/auxiliary/tracking/t_tracking.h @@ -296,7 +296,7 @@ t_hsv_filter_sample(struct t_hsv_filter_optimized_table *t, uint32_t y, uint32_t * Construct an HSV filter sink. * @public @memberof t_hsv_filter * - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_hsv_filter_create(struct xrt_frame_context *xfctx, @@ -500,7 +500,7 @@ t_calibration_params_default(struct t_calibration_params *p) * @param gui Frame sink * @param out_sink Output: created frame sink. * - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_calibration_stereo_create(struct xrt_frame_context *xfctx, @@ -517,7 +517,7 @@ t_calibration_stereo_create(struct xrt_frame_context *xfctx, */ /*! - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_convert_yuv_or_yuyv_create(struct xrt_frame_sink *next, struct xrt_frame_sink **out_sink); @@ -525,7 +525,7 @@ t_convert_yuv_or_yuyv_create(struct xrt_frame_sink *next, struct xrt_frame_sink /*! - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_debug_hsv_picker_create(struct xrt_frame_context *xfctx, @@ -533,7 +533,7 @@ t_debug_hsv_picker_create(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_sink); /*! - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_debug_hsv_viewer_create(struct xrt_frame_context *xfctx, @@ -541,7 +541,7 @@ t_debug_hsv_viewer_create(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_sink); /*! - * @relates xrt_frame_context + * @see xrt_frame_context */ int t_debug_hsv_filter_create(struct xrt_frame_context *xfctx, diff --git a/src/xrt/auxiliary/util/u_sink.h b/src/xrt/auxiliary/util/u_sink.h index 44558fc74..1f26469eb 100644 --- a/src/xrt/auxiliary/util/u_sink.h +++ b/src/xrt/auxiliary/util/u_sink.h @@ -26,8 +26,8 @@ struct u_sink_quirk_params }; /*! - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_create_format_converter(struct xrt_frame_context *xfctx, @@ -36,8 +36,8 @@ u_sink_create_format_converter(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_create_to_r8g8b8_or_l8(struct xrt_frame_context *xfctx, @@ -45,8 +45,8 @@ u_sink_create_to_r8g8b8_or_l8(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_create_to_r8g8b8_bayer_or_l8(struct xrt_frame_context *xfctx, @@ -54,8 +54,8 @@ u_sink_create_to_r8g8b8_bayer_or_l8(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_create_to_yuv_yuyv_uyvy_or_l8(struct xrt_frame_context *xfctx, @@ -63,17 +63,16 @@ u_sink_create_to_yuv_yuyv_uyvy_or_l8(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_create_to_yuv_or_yuyv(struct xrt_frame_context *xfctx, struct xrt_frame_sink *downstream, struct xrt_frame_sink **out_xfs); /*! - * @public @memberof u_sink_deinterleaver - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_deinterleaver_create(struct xrt_frame_context *xfctx, @@ -81,9 +80,8 @@ u_sink_deinterleaver_create(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @public @memberof u_sink_queue - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ bool u_sink_queue_create(struct xrt_frame_context *xfctx, @@ -91,9 +89,8 @@ u_sink_queue_create(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @public @memberof u_sink_quirk - * @relatesalso xrt_frame_sink - * @relates xrt_frame_context + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_quirk_create(struct xrt_frame_context *xfctx, @@ -102,8 +99,8 @@ u_sink_quirk_create(struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_xfs); /*! - * @public @memberof u_sink_split - * @relatesalso xrt_frame_sink + * @public @memberof xrt_frame_sink + * @see xrt_frame_context */ void u_sink_split_create(struct xrt_frame_context *xfctx,