Team2890/PhotonVision
4
0
Fork 0
mirror of https://github.com/PhotonVision/photonvision synced 2026-06-23 01:21:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc warnings (#2266)

Browse Source 
Persuant to #1093, I added as many docstrings as I could, at least for
things I knew about. Some of the classes I just suppressed the Javadoc
warnings in because they aren't particularly useful to document. This
gets us down to less than 100 Javadoc warnings in total. Docs for core
classes on the C++ side were also added for parity.
This commit is contained in:
Gold856
2026-01-11 14:25:49 -05:00
committed by GitHub
parent a5dc9ec0d6
commit e4749a3ea9
39 changed files with 1306 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
photon-lib/src/main/native/include/photon/PhotonCamera.h
View File

@@ -179,20 +179,29 @@ class PhotonCamera {
using DistortionMatrix = Eigen::Matrix<double, 8, 1>;
/**
* @brief Get the camera calibration matrix, in standard OpenCV form
* Get the camera calibration matrix, in standard OpenCV form
*
* @return std::optional<cv::Mat>
*/
std::optional<CameraMatrix> GetCameraMatrix();
/**
* @brief Get the camera calibration distortion coefficients, in OPENCV8 form.
* Higher order terms are set to zero.
* Returns the camera calibration's distortion coefficients, in OPENCV8 form.
* Higher-order terms are set to 0
*
* @return std::optional<cv::Mat>
* @return The distortion coefficients in a 8x1 matrix, if they are published
* by the camera. Empty otherwise.
*/
std::optional<DistortionMatrix> GetDistCoeffs();
/**
* Sets whether or not coprocessor version checks will occur. Setting this to
* true will silence all console warnings about coproccessor connection, so be
* careful when enabling this and ensure all your coprocessors are
* communicating to the robot properly and everything has matching versions.
*
* @param enabled Whether or not to enable coprocessor version checks
*/
static void SetVersionCheckEnabled(bool enabled);
std::shared_ptr<nt::NetworkTable> GetCameraTable() const { return rootTable; }