docs: Add comprehensive API documentation for all contracts

[cypriannwokolo2-creator]

Description

All contracts need comprehensive API documentation including function signatures, parameters, return values, error codes, and usage examples.

Requirements

• Document all public functions with rustdoc comments
• Add parameter descriptions and return value documentation
• Document error codes with human-readable descriptions
• Add usage examples for each function

Acceptance Criteria

• All public functions documented
• Error codes documented
• Usage examples provided
• Documentation builds without warnings

Priority

Low

[webdevayo]

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

Hi maintainer I have thoroughly read the description to this issue and I can resolve this according to the description required ensuring it meet all the acceptance criteria kindly assign..

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

[rilwanubala]

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

Hi, Please allow me to work on this issue

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

[abdulrcrtw]

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

Hi, I'd like to work on this issue.

I'll rewrite the relevant docs to be accurate and clear, matching the existing documentation conventions.

Planned approach, based on the acceptance criteria:

• All public functions documented
• Error codes documented
• Usage examples provided
• Documentation builds without warnings

Please assign this issue to me, I'd be happy to contribute.

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

[Abbyhay]

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

I’ve taken the time to understand this issue and its requirements. I believe I can resolve it effectively and would appreciate the chance to work on it

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

[dimin4241-svg]

@dimin4241-svg has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I have hands-on experience documenting Soroban and Rust contracts and their public APIs. I reviewed this issue and can map each shipped contract's entry points and examples into a consistent reference while keeping generated details accurate. I can complete the documentation pass within 1–2 days of assignment. Please assign it to me.

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

[Ceepr1an]

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

I can fix this issue

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

[drips-wave]

Congratulations, @abdulrcrtw! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @abdulrcrtw: 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 🌊