doc(core): document remaining public API + enable crate-wide missing_docs (#226) - #236
Open
kalwalt wants to merge 1 commit into
Open
doc(core): document remaining public API + enable crate-wide missing_docs (#226)#236kalwalt wants to merge 1 commit into
kalwalt wants to merge 1 commit into
Conversation
…docs (#226) Slice 3b — the finisher for #226. Documents the last of the undocumented public surface and turns on the crate-wide gate. - types.rs: the ARToolKit core types — ARHandle, ARParamLT(f), ARLabelInfo, ARPattHandle, ARPixelFormat / ARMatrixCodeType / labeling enums, timestamps, constants, and the cutoff-phase variants (116 items). - ar/*: math (ARMat/ARMatf/ARVec + PCA/QR helpers), marker/pattern/matrix/ pose/labeling/image_proc/bch constants, enums, and functions. - arlog.rs: log-level variants + the arlog_{d,i,w,e} macros. Then add `#![warn(missing_docs)]` at the crate root. The whole crate (default and --all-features) now reports zero missing_docs; CI's `clippy -D warnings` escalates the lint, so any new undocumented public item fails the build. The bindgen-generated FFI bindings keep their local `#![allow(missing_docs)]` (kpm::kpm_ffi). Documentation only — no code or signatures changed. Verified: rustdoc 0 missing (default + all-features), `clippy --workspace --all-targets --all-features -D warnings` clean, `cargo test --lib` 432 passed. Closes the API-reference half of #226. Refs #226 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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 3b — the finisher for #226. Documents the last of the undocumented public surface and turns on the crate-wide
#![warn(missing_docs)]gate.What's documented
types.rs(116) — the ARToolKit core types:ARHandle,ARParamLT/ARParamLTf,ARLabelInfo,ARPattHandle, theARPixelFormat/ARMatrixCodeType/ labeling enums, timestamps, the mode/threshold constants, and theARMarkerInfoCutoffPhasevariants.ar/*—math(ARMat/ARMatf/ARVec+ PCA/QR/eigen helpers), and themarker/pattern/matrix/pose/labeling/image_proc/bchconstants, enums, and functions.arlog.rs— the log-level variants + thearlog_{d,i,w,e}macros.The gate
Adds
#![warn(missing_docs)]at the crate root. The crate now reports zero missing docs on both default features and--all-features; CI'sclippy -D warningsescalates the lint, so any new undocumentedpubitem fails the build from here on. The bindgen-generated FFI bindings keep their local#.Verification
cargo rustdoc -W missing_docs: 0 (default) and 0 (--all-features)cargo clippy --workspace --all-targets --all-features -D warnings: clean (run locally withLIBCLANG_PATHset to an x64 libclang — the exact CI command)cargo fmt --checkclean;cargo test --lib: 432 passedDocumentation only — no code or signatures changed.
#226 status
With #231 (KPM rustdoc), #232 (JS/TS guide), #233 (AR2/ICP), and this PR, the API-reference + integration-guide scope of #226 is complete → #226 can be closed on merge.
Out of scope (tracked separately if desired): the ~43 pre-existing broken intra-doc links (e.g.
arlog_rel,_verbosehelpers) — those arecargo docwarnings, not part of theclippygate.🤖 Generated with Claude Code