The open source OpenXR runtime

a/tracking: Fix doxygen warnings

authored by

Ryan Pavlik and committed by
Jakob Bornecrantz
5fc532d2 7fb06198

+7 -6
+3 -3
src/xrt/auxiliary/tracking/t_euroc_recorder.h
··· 36 36 /*! 37 37 * Start recording samples sent to the recorder sinks. 38 38 * 39 - * @param er The recorder sinks returned by @ref euroc_recorder_create 39 + * @param er_sinks The recorder sinks returned by @ref euroc_recorder_create 40 40 */ 41 41 void 42 42 euroc_recorder_start(struct xrt_slam_sinks *er_sinks); ··· 45 45 * Stop recording samples sent to the recorder sinks. You can start and 46 46 * stop as many times as you like. 47 47 * 48 - * @param er The recorder sinks returned by @ref euroc_recorder_create 48 + * @param er_sinks The recorder sinks returned by @ref euroc_recorder_create 49 49 */ 50 50 void 51 51 euroc_recorder_stop(struct xrt_slam_sinks *er_sinks); ··· 53 53 /*! 54 54 * Add EuRoC recorder UI button to start recording after creation. 55 55 * 56 - * @param er The sinks returned by @ref euroc_recorder_create 56 + * @param er_sinks The sinks returned by @ref euroc_recorder_create 57 57 * @param root The pointer to add UI button to 58 58 * @param prefix Prefix in case you have multiple recorders, otherwise pass an empty string 59 59 */
+1
src/xrt/auxiliary/tracking/t_openvr_tracker.h
··· 15 15 extern "C" { 16 16 #endif 17 17 18 + /// The type of device 18 19 enum openvr_device 19 20 { 20 21 T_OPENVR_DEVICE_UNKNOWN = 0,
+3 -3
src/xrt/auxiliary/tracking/t_tracking.h
··· 133 133 134 134 135 135 /*! 136 - * Stringifies a @ref enum t_camera_distortion_model 136 + * Stringifies a @ref t_camera_distortion_model 137 137 * @param model The distortion model to be stringified 138 138 * @return The distortion model as a string 139 139 */ ··· 151 151 } 152 152 153 153 /*! 154 - * Returns the number of parameters needed for this @ref enum t_camera_distortion_model to be held by an OpenCV Mat and 154 + * Returns the number of parameters needed for this @ref t_camera_distortion_model to be held by an OpenCV Mat and 155 155 * correctly interpreted by OpenCV's (un)projection functions. 156 156 * 157 157 * @param model The distortion model in question ··· 651 651 int cam_count; //!< Number of cameras in use 652 652 bool slam_ui; //!< Whether to open the external UI of the external SLAM system 653 653 bool submit_from_start; //!< Whether to submit data to the SLAM tracker without user action 654 - int openvr_groundtruth_device; //!< If >0, use lighthouse as groundtruth, see @ref enum openvr_device 654 + int openvr_groundtruth_device; //!< If >0, use lighthouse as groundtruth, see @ref openvr_device 655 655 enum t_slam_prediction_type prediction; //!< Which level of prediction to use 656 656 bool write_csvs; //!< Whether to enable CSV writers from the start for later analysis 657 657 const char *csv_path; //!< Path to write CSVs to