Add Structured Doc Comments for Public APIs

[Baskarayelu]

Description:

Make all public contract functions ready for auto-generated docs.

Requirements

• Ensure each public function has complete Rust doc comments (description, args, returns, errors).
• Run cargo doc and fix warnings.

Acceptance Criteria

• All public functions documented
• cargo doc runs cleanly

[drips-wave]

This issue has been added to the Stellar Wave Program and is worth 200 Points.

🧑‍💻 Interested in contributing? Apply to work on this issue on Drips Wave, earn points, and receive rewards.

Warning

Only applications submitted via the apply link above will be considered. Please do not apply by commenting on the issue or opening a PR directly.

🤠 Repo maintainers: You can manage this issue's Points and Complexity on your Maintainer Dashboard here. Please keep an eye on applications and respond quickly 💙

ℹ️ Learn more about Drips Wave

[Bhenzdizma]

@Bhenzdizma has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hello, i can work on this, sir please consider my request

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

[Eniola3321]

@Eniola3321 has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi Maintainers,
I’m interested in working on this issue. I’m a backend developer with experience in Node.js, APIs, and Web3/blockchain concepts.
I’ve reviewed the issue and I’m confident I can contribute a clean solution.
Kindly assign it to me if it’s open. Thanks!

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

[Skinny001]

I will add complete Rust documentation comments to all public contract functions, including descriptions, parameters, return values, and possible errors. I will run cargo doc and resolve any warnings to ensure clean, auto-generated documentation.
please assign me the issue

[Skinny001]

I will ensure all public contract functions include complete Rust documentation comments covering descriptions, parameters, return values, and possible errors. I will also run cargo doc and resolve any warnings to guarantee clean, auto-generated documentation.
please assign the issue to me

[rocknwa]

@rocknwa has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi team,

I’d like to take on Issue #183 – Add Structured Doc Comments for Public APIs.

Plan:

• Add complete Rust doc comments (///) for all public contract functions:

  • Clear description
  • # Arguments
  • # Returns
  • # Errors

• Ensure consistency and clarity for auto-generated documentation.

• Run cargo doc and resolve any warnings.

Goal:

• All public APIs fully documented
• cargo doc builds cleanly with no warnings

This will make the contracts easier to understand, integrate, and audit.

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

[meshackyaro]

@meshackyaro has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi, I'll like to work on this issue. I have the technical know-how to deliver this in due time since I'm already familiar with the codebase

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

[Miracle656]

@Miracle656 has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi team 👋

I'd love to work on this! I'm already contributing to the Remitwise ecosystem on the frontend side (#144, #146, #154), and I have hands-on experience with Soroban smart contract development, so I'm comfortable reading and documenting the contract code here.

Here's my plan:

Approach:

• Audit all public functions across the contracts (remittance split, savings goals, bill payments, insurance, family wallet) and identify any missing or incomplete doc comments
• For each public function, add complete Rust doc comments following this structure:

/// Brief one-line description of what the function does.
///
/// # Arguments
/// * `env` - The Soroban environment
/// * `param_name` - Description of the parameter
///
/// # Returns
/// Description of the return value and type
///
/// # Errors
/// * `ContractError::Unauthorized` - When caller lacks permission
/// * `ContractError::InvalidAmount` - When amount is zero or negative

• Run cargo doc --no-deps iteratively to catch and fix all warnings
• Ensure doc comments are accurate to the actual implementation, not just boilerplate

A few quick questions:

• Are the contracts in a single crate or split across multiple workspace members?
• Is there an existing error enum I should reference for the # Errors sections?
• Any doc style guide or existing documented functions to use as a reference?

Estimated delivery: 3–4 days from assignment.

Please assign it to me 🙌

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

[sublime247]

@sublime247 has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

gm boss

I would like to work on this issue

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

[DavisVT]

@DavisVT has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

pls assign me to this issue

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