Skip to content

doc(core): document remaining public API + enable crate-wide missing_docs (#226) - #236

Open
kalwalt wants to merge 1 commit into
devfrom
doc/api-reference-fields-226-b
Open

doc(core): document remaining public API + enable crate-wide missing_docs (#226)#236
kalwalt wants to merge 1 commit into
devfrom
doc/api-reference-fields-226-b

Conversation

@kalwalt

@kalwalt kalwalt commented Jul 21, 2026

Copy link
Copy Markdown
Member

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, the ARPixelFormat / ARMatrixCodeType / labeling enums, timestamps, the mode/threshold constants, and the ARMarkerInfoCutoffPhase variants.
  • ar/*math (ARMat/ARMatf/ARVec + PCA/QR/eigen helpers), and the marker/pattern/matrix/pose/labeling/image_proc/bch constants, enums, and functions.
  • arlog.rs — the log-level variants + the arlog_{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's clippy -D warnings escalates the lint, so any new undocumented pub item fails the build from here on. The bindgen-generated FFI bindings keep their local #![allow(missing_docs)] (kpm::kpm_ffi, from #231).

Verification

  • cargo rustdoc -W missing_docs: 0 (default) and 0 (--all-features)
  • cargo clippy --workspace --all-targets --all-features -D warnings: clean (run locally with LIBCLANG_PATH set to an x64 libclang — the exact CI command)
  • cargo fmt --check clean; cargo test --lib: 432 passed

Documentation 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, _verbose helpers) — those are cargo doc warnings, not part of the clippy gate.

🤖 Generated with Claude Code

…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

codecov Bot commented Jul 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kalwalt kalwalt self-assigned this Jul 21, 2026
@kalwalt kalwalt added documentation Improvements or additions to documentation enhancement New feature or request rust code labels Jul 21, 2026
@kalwalt kalwalt added this to the Stabilization & DX milestone Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request rust code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant