Skip to content

Throw errors for doxygen warnings#2487

Draft
samfreund wants to merge 5 commits into
PhotonVision:mainfrom
samfreund:error-on-doxygen-warn
Draft

Throw errors for doxygen warnings#2487
samfreund wants to merge 5 commits into
PhotonVision:mainfrom
samfreund:error-on-doxygen-warn

Conversation

@samfreund

@samfreund samfreund commented May 11, 2026

Copy link
Copy Markdown
Member

Throw errors for any warnings we find generating the C++ docs for photonlib. Also fixes some out of date docs

@github-actions github-actions Bot added documentation Anything relating to https://docs.photonvision.org photonlib Things related to the PhotonVision library labels May 11, 2026
@samfreund samfreund force-pushed the error-on-doxygen-warn branch from 200f351 to 1e39dcb Compare May 11, 2026 22:36
@samfreund

Copy link
Copy Markdown
Member Author

@mcm001 we're hitting the below error since WPILIB isn't within our project. It seems like we can link it? But I'm not quite sure how, and was wondering if you knew the best way to do it. We can also just not link it.

/home/runner/work/photonvision/photonvision/photon-lib/src/main/native/include/photon/PhotonUtils.h:118: error: unable to resolve reference to 'wpi::math::Transform2d' for \ref command
/home/runner/work/photonvision/photonvision/photon-lib/src/main/native/include/photon/PhotonCamera.h:63: error: unable to resolve reference to 'NetworkTableInstance::getDefault' for \ref command
/home/runner/work/photonvision/photonvision/photon-lib/src/main/native/include/photon/PhotonUtils.h:118: error: unable to resolve reference to 'wpi::math::Transform2d' for \ref command
/home/runner/work/photonvision/photonvision/photon-lib/src/main/native/include/photon/PhotonUtils.h:118: error: unable to resolve reference to 'wpi::math::Transform2d' for \ref command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything relating to https://docs.photonvision.org photonlib Things related to the PhotonVision library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant