Add NatSpec-style /// rustdoc to all public functions in disputes.rs DisputeManager

[greatest0fallt1me]

Description

The DisputeManager in disputes.rs (process_dispute, resolve_dispute, vote_on_dispute, calculate_dispute_outcome, distribute_dispute_fees, claim_dispute_winnings) is core to dispute resolution but lacks consistent /// documentation describing parameters, authorization requirements, errors, and state transitions. Complete rustdoc improves auditability and client integration.

Requirements and Context

• Add /// doc comments to every public function and struct in contracts/predictify-hybrid/src/disputes.rs.
• Document parameters, returned Error variants, required auth, and resulting DisputeStatus transition.
• Keep examples compiling under cargo test --doc where included.
• Must be secure, tested, and documented
• Should be efficient and easy to review

Suggested Execution

1. Fork the repo and create a branch

   git checkout -b task/disputes-rustdoc

2. Implement changes
   • contracts/predictify-hybrid/src/disputes.rs
   • Sync narrative docs in docs/contracts/ if dispute behavior is referenced.
3. Test and commit
   • cargo doc -p predictify-hybrid --no-deps and cargo test -p predictify-hybrid --doc
   • Cover edge cases: documented error paths match actual returns
   • Include test output and notes in the PR

Example commit message

docs: add rustdoc to DisputeManager public API

Acceptance Criteria

• Every public item in disputes.rs has a /// doc block
• cargo doc builds with no missing-docs warnings for the module
• Documented errors match the implementation

Guidelines

• NatSpec-style /// doc comments, accurate error/auth documentation
• Clear documentation and inline comments
• Timeframe: 96 hours

[michaelvic123]

@michaelvic123 has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

please assign me this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @michaelvic123 to this issue.

[drips-wave]

Congratulations, @michaelvic123! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @michaelvic123: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[drips-wave]

This issue has been completed by @michaelvic123 as part of the Stellar Wave Program's 5th Wave 🥳

😎 @michaelvic123: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.