Add JSDoc/typedoc comments to escrow/create.ts, cancel.ts, release.ts and dispute.ts

[meshackyaro]

Description

typedoc-driven documentation generation (per the repo's existing Typedoc setup, issue #7) depends on JSDoc comments on exported symbols. src/client.ts and src/escrow/multisig.ts both have thorough /** ... */ blocks with @param, @returns, @throws, and @example tags on every public method. By contrast, src/escrow/create.ts's createEscrow, src/escrow/cancel.ts's cancelEscrow/getEscrow, src/escrow/release.ts's releaseEscrow, and src/escrow/dispute.ts's DisputeClient class and its raiseDispute/getDispute methods have no JSDoc at all — just inline // comments describing intended future behavior. Any generated Typedoc site would show rich documentation for some of the SDK's most central operations (multisig) and essentially blank pages for others (plain create/release/cancel/dispute), with no consistent standard applied.

Component

SDK

Difficulty

🟢 Easy

Tasks

• Add /** ... */ doc comments with @param/@returns/@throws to every exported function/class in the four files above, matching the style already used in client.ts/multisig.ts
• Add at least one @example block per function, matching the style in client.ts
• Regenerate the Typedoc output locally to confirm the new comments render as expected

Acceptance Criteria

• Every exported function/class in escrow/create.ts, cancel.ts, release.ts, and dispute.ts has JSDoc matching the depth/style already established in client.ts and multisig.ts

Estimated Time

1-2 days

[smithd2423-beep]

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

Hi Maintainer, I’d be glad to take on this issue. I’ve worked on similar tasks before and have the experience needed to handle it. I’m ready to get started right away.

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

[aojomo]

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

Hi maintainer Please I would like to work on this issue

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

[solaawojobi00-bit]

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

I’ll take this on. In trustflow-sdk, public exported functions across src/escrow/create.ts, cancel.ts, release.ts, and dispute.ts lack JSDoc comments, resulting in incomplete API documentation when generated via TypeDoc.
I will implement:

• Comprehensive JSDoc/TypeDoc Annotations: Add thorough /** ... */ documentation blocks to createEscrow (create.ts), cancelEscrow/getEscrow (cancel.ts), releaseEscrow (release.ts), and the DisputeClient class with its raiseDispute/getDispute methods (dispute.ts).
• Tag Consistency: Ensure all newly documented exported symbols include @PARAM, @returns, @throws, and practical @example tags matching the standards established in src/client.ts and src/escrow/multisig.ts.
• Documentation Verification: Verify that TypeDoc builds cleanly and renders detailed documentation for all updated escrow modules. Kindly assign it to me.

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

[Majormaxx]

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

Hi team, can I tackle this? ETA is 4 hours

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

[drips-wave]

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

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