Write Rust API documentation comments
api-doc-commentsskillsetup L1★123
axone-protocol/contracts ↗What it does
Write semantically precise Rust doc comments for schema-facing APIs
Best for
Documenting smart contract ABIs where generated docs must be client-accessible and precise.
Inputs
- · Rust message/enum/field definitions
Outputs
- · Documented Rust types with schema semantics
Requires
- · Rust doc compiler
- · contract schema generator
Preconditions
- · Schema types defined
- · Doc regeneration workflow available
Failure modes
- · Comments missing preconditions
- · Generic restatements instead of domain semantics
Trust signals
- · Clear enum variant explanation
- · Precondition + invariant coverage
- · Encoded format documented