ci(tooling): add lint for enum-level (not just variant-level) doc com…

[mctituschristian]

…ments

Closes #446.

Problem

Issue #69 added rustdoc comments to every individual error variant but nothing enforced — or even consistently required — a doc comment on the enum declaration itself. A reader landing on an enum with 14 variants and no framing comment has no high-level context before diving into the individual descriptions.

Solution

scripts/check-enum-doc-comments.sh — a new grep-based lint script that scans every non-test .rs file under contracts/ and crates/ for pub enums preceded by #[contracterror] or #[contracttype], and verifies that at least one '///' doc-comment line appears in the contiguous attribute block immediately before the enum declaration.

Integration

• .pre-commit-config.yaml: new 'check-enum-doc-comments' hook runs after the existing check-enum-ordering hook on every commit.
• justfile / Makefile: 'precommit' target updated to call the script so 'just precommit' / 'make precommit' mirrors CI exactly.

Doc comments added

All #[contracterror]/#[contracttype] enums that were missing an enum-level /// comment now have one:

crates/multisig — TreasuryError, SettlementHoldReason,
SettlementStatus, DisputeStatus,
RotationStatus, DataKey
crates/compliance-errors — ComplianceError
crates/invoice-errors — InvoiceError
contracts/compliance — DataKey (moved comment before attribute)
contracts/invoice — InvoiceStatus, MaybeAddress, MaybeBytes, DataKey
contracts/settlement-workflow — DataKey (duplicate variant also fixed)

Verification

bash scripts/check-enum-doc-comments.sh → exit 0 (all pass)
[remove a doc comment] && bash scripts/... → exit 1 (caught)

Description

Related Issue

Closes #[issue_id]

Checklist

• Description of changes included
• Test coverage confirmation (new/updated tests added)
• Screenshot/gif for UI changes (if applicable)
• ABI snapshot regenerated (if contract interface changed)
• just check passing locally
  Closes Add a lint step verifying every new #[contracterror]/#[contracttype] enum has a doc comment on the enum itself, not just its variants #446

[drips-wave]

@mctituschristian Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits