doc(ar2,icp): document the AR2 tracking + ICP public API (#226) - #233
Merged
Conversation
Slice 3a of the #226 documentation pass — fills the missing_docs on the AR2 tracking and ICP pose-refinement layer (~148 items): - icp.rs: ICP coordinate/line/data/handle structs + all icp_* functions (icpCore port). - ar2/tracking.rs: the AR2Handle config + working buffers, the feature / template / image-set structs, the tracking constants, AR2Tracking2DResult, and all ar2_* / helper functions. - ar2/surface.rs: AR2Surface / AR2SurfaceSet (per-surface pose + tracking state). Documentation only — no code or signatures changed. The crate-wide `#![warn(missing_docs)]` gate lands in the follow-up slice once the remaining modules (types.rs, ar/*, arlog.rs, kpm stragglers) are covered. Refs #226 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Slice 3a of #226 (field-doc back-fill), split into two PRs per the plan. #226 stays open — the gate + remaining modules land in slice 3b.
Scope — AR2 tracking + ICP pose-refinement layer (~148 items)
icp.rs— ICP coordinate / line / data / handle structs (ICP2DCoordT,ICP3DCoordT,ICPHandleT,ICPStereoHandleT, …) + allicp_*functions (icpCore port).ar2/tracking.rs—AR2Handle(config + per-frame buffers), the feature/template/image-set structs (AR2Template,AR2FeatureSet,AR2ImageSet, …), the tracking constants,AR2Tracking2DResult, and allar2_*/helper functions.ar2/surface.rs—AR2Surface/AR2SurfaceSet(per-surface pose + tracking state).Documentation only — no code or signatures changed. Field docs are grounded in the ARToolKit
ar2Tracking/icpCoresemantics.Verification
cargo rustdoc -W missing_docs: these three files now report 0cargo doc: no new broken intra-doc links in the touched filescargo fmt --checkclean;clippy --all-targets --features simd,log-helpers -D warningsclean;cargo test --lib(ar2 + icp) greenFollow-up — slice 3b
types.rs(116) +ar/*+arlog.rs+ kpm stragglers, then add the crate-wide#![warn(missing_docs)]gate (it can only be enabled once the whole crate is at zero). Crate-wide count so far: 358 → 180.🤖 Generated with Claude Code