mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-03-04 05:36:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

a/tracking: Fix doxygen warnings

Browse source
This commit is contained in:
Ryan Pavlik 2023-09-13 12:53:32 -05:00 committed by Jakob Bornecrantz
parent 7fb06198cf
commit 5fc532d23f
3 changed files with 7 additions and 6 deletions

6
src/xrt/auxiliary/tracking/t_euroc_recorder.h
View file

@ -36,7 +36,7 @@ euroc_recorder_create(struct xrt_frame_context *xfctx, const char *record_path,
/*!
* Start recording samples sent to the recorder sinks.
*
* @param er The recorder sinks returned by @ref euroc_recorder_create
* @param er_sinks The recorder sinks returned by @ref euroc_recorder_create
*/
void
euroc_recorder_start(struct xrt_slam_sinks *er_sinks);
@ -45,7 +45,7 @@ euroc_recorder_start(struct xrt_slam_sinks *er_sinks);
* Stop recording samples sent to the recorder sinks. You can start and
* stop as many times as you like.
*
* @param er The recorder sinks returned by @ref euroc_recorder_create
* @param er_sinks The recorder sinks returned by @ref euroc_recorder_create
*/
void
euroc_recorder_stop(struct xrt_slam_sinks *er_sinks);
@ -53,7 +53,7 @@ euroc_recorder_stop(struct xrt_slam_sinks *er_sinks);
/*!
* Add EuRoC recorder UI button to start recording after creation.
*
* @param er The sinks returned by @ref euroc_recorder_create
* @param er_sinks The sinks returned by @ref euroc_recorder_create
* @param root The pointer to add UI button to
* @param prefix Prefix in case you have multiple recorders, otherwise pass an empty string
*/

1
src/xrt/auxiliary/tracking/t_openvr_tracker.h
View file

@ -15,6 +15,7 @@
extern "C" {
#endif
/// The type of device
enum openvr_device
{
T_OPENVR_DEVICE_UNKNOWN = 0,

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

@ -133,7 +133,7 @@ enum t_camera_distortion_model
/*!
* Stringifies a @ref enum t_camera_distortion_model
* Stringifies a @ref t_camera_distortion_model
* @param model The distortion model to be stringified
* @return The distortion model as a string
*/
@ -151,7 +151,7 @@ t_stringify_camera_distortion_model(const enum t_camera_distortion_model model)
}
/*!
* Returns the number of parameters needed for this @ref enum t_camera_distortion_model to be held by an OpenCV Mat and
* Returns the number of parameters needed for this @ref t_camera_distortion_model to be held by an OpenCV Mat and
* correctly interpreted by OpenCV's (un)projection functions.
*
* @param model The distortion model in question
@ -651,7 +651,7 @@ struct t_slam_tracker_config
int cam_count; //!< Number of cameras in use
bool slam_ui; //!< Whether to open the external UI of the external SLAM system
bool submit_from_start; //!< Whether to submit data to the SLAM tracker without user action
int openvr_groundtruth_device; //!< If >0, use lighthouse as groundtruth, see @ref enum openvr_device
int openvr_groundtruth_device; //!< If >0, use lighthouse as groundtruth, see @ref openvr_device
enum t_slam_prediction_type prediction; //!< Which level of prediction to use
bool write_csvs; //!< Whether to enable CSV writers from the start for later analysis
const char *csv_path; //!< Path to write CSVs to