Revenue pool: complete missing rustdoc for set_admin and add module-level safety docs

[greatest0fallt1me]

Description

In contracts/revenue_pool/src/lib.rs the doc block above set_admin was clearly mis-merged — the /// comment for the two-step transfer flows directly into get_usdc_token's docs, and set_admin itself carries no dedicated rustdoc. Restore accurate per-function NatSpec-style docs and align them with the emitted admin_changed and admin_transfer_started events.

Requirements and Context

• Give set_admin its own /// block documenting args, panics, and both emitted events.
• Fix the stray doc text currently bleeding into get_usdc_token.
• Verify every pub fn in the crate has complete arg/panic/event docs.
• 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/revenue-pool-rustdoc-fix

2. Implement changes
   • contracts/revenue_pool/src/lib.rs — correct and complete /// docs
3. Test and commit
   • cargo doc -p callora-revenue-pool --no-deps
   • cargo clippy -p callora-revenue-pool -- -D warnings
   • Include build output in the PR

Example commit message

docs: restore set_admin rustdoc in revenue pool

Acceptance Criteria

• set_admin has dedicated, accurate /// docs
• No doc text bleeds across functions
• All pub fn documented with args/panics/events
• cargo doc builds cleanly

Guidelines

• .rs under contracts/revenue_pool/src/, cargo test, /// docs, minimum 95% line coverage, no unwrap() in prod paths
• Clear documentation and inline comments
• Timeframe: 96 hours

[Vvictor-commits]

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

please asign this issue to me

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

[drips-wave]

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

🧑‍💻 @Vvictor-commits: 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 @Vvictor-commits as part of the Stellar Wave Program's 5th Wave 🥳

😎 @Vvictor-commits: 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.