a/tracking: Fix some it's vs its and other minor doc tweaks

This commit is contained in:
Ryan Pavlik 2021-11-03 17:27:36 -05:00
parent f4b61d9e41
commit 334bd83619
2 changed files with 12 additions and 6 deletions

View file

@ -36,10 +36,10 @@ extern "C" {
* holds the controllers with the ball pointing up and the buttons on the back
* pointing forward. Which if you read the documentation of @ref psmv_device
* will that the axis of the PSMV are also perfectly aligned with the users
* coordinate system. So everything "attached" to the user have it's coordinate
* coordinate system. So everything "attached" to the user has its coordinate
* system parallel to the user's.
*
* The camera on the other hand is looking directly at the user, it's Z-axis and
* The camera on the other hand is looking directly at the user, its Z-axis and
* X-axis is flipped in relation to the user's. So to compare what is sees to
* what the user sees, everything is rotated 180° around the Y-axis.
*/

View file

@ -118,11 +118,11 @@ t_stereo_camera_calibration_destroy(struct t_stereo_camera_calibration *c);
/*!
* Update the reference counts on a stereo calibration data(s).
*
* @param dst Pointer to a object reference, if the object reference is
* non-null will decrement it's counter. The reference that
* @param[in,out] dst Pointer to a object reference: if the object reference is
* non-null will decrement its counter. The reference that
* @p dst points to will be set to @p src.
* @param[in] src Object to be have it's refcount increased @p dst is set to
* this.
* @param[in] src New object for @p dst to refer to (may be null).
* If non-null, will have its refcount increased.
*
* @relates t_stereo_camera_calibration
*/
@ -150,18 +150,24 @@ t_stereo_camera_calibration_reference(struct t_stereo_camera_calibration **dst,
/*!
* Small helper function that dumps the calibration data to logging.
*
* @relates t_stereo_camera_calibration
*/
void
t_stereo_camera_calibration_dump(struct t_stereo_camera_calibration *c);
/*!
* Load stereo calibration data from a given file.
*
* @relates t_stereo_camera_calibration
*/
bool
t_stereo_camera_calibration_load_v1(FILE *calib_file, struct t_stereo_camera_calibration **out_data);
/*!
* Save the given stereo calibration data to the given file.
*
* @relates t_stereo_camera_calibration
*/
bool
t_stereo_camera_calibration_save_v1(FILE *calib_file, struct t_stereo_camera_calibration *data);