Add inline JSDoc comments to all public API types and interfaces

[Akatenvictor]

What

Add JSDoc documentation to all exported TypeScript interfaces, types, and function signatures across the codebase.

Why

Well-documented types improve IDE experience with hover tooltips and help developers understand API contracts without reading implementation.

Scope

In: JSDoc for all exported interfaces, types, and functions in lib/ and hooks/
Out: Full API documentation site

Acceptance Criteria

• All exported interfaces have description and @Property tags
• All exported functions have description, @PARAM, @returns tags
• Complex types have usage examples
• No TypeScript errors after adding JSDoc
• IDE hover tooltips show documentation
• Documentation passes eslint rule for JSDoc

Technical Context

• Add JSDoc to lib/apiClient.ts, lib/utils.ts
• Add JSDoc to hooks/*.ts
• Configure eslint-plugin-jsdoc

[blurbeast]

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

hello my Chief, can i jump on this ??

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

[brobryann]

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

Please I would like to work on this issue, i'll add JSDoc (description, @param/@returns/@Property tags, usage examples for complex types) across exported interfaces and functions in lib/ and hooks/, configure eslint-plugin-jsdoc, and confirm no TS errors and hover tooltips work

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

[drips-wave]

Congratulations, @Cjay-Cyber-2! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on July 30, 2026.

🧑‍💻 @Cjay-Cyber-2: 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 🌊