Add JSDoc standard comments to all core utility functions and hooks#328
Merged
AlAfiz merged 1 commit intoJun 18, 2026
Merged
Conversation
…ooks Adds comprehensive JSDoc blocks to all exported functions in: - src/lib/ (api.ts, breadcrumbs.ts, env.ts, httpClient.ts, toast.ts, networkConfig.ts, walletCache.ts, stellar.ts, apiHealth.ts, walletConnector.ts, riskSocket.ts, freighterErrors.ts) - src/hooks/ (useInvoice.ts, useRepayInvoice.ts, useMintInvoice.ts, useNetworkDetection.ts, useTxWithToast.ts, useTransactionToast.tsx) Each exported function now includes @param, @returns, and @throws documentation. Closes BETAIL-BOYS#269
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive JSDoc documentation to every exported function in
src/lib/utils/andsrc/hooks/.Changes
lib/ (12 files)
api.ts- Documented internal helpers and RequestOptions interfacebreadcrumbs.ts- Added JSDoc to generateBreadcrumbs and getPageTitleenv.ts- Documented getWsBaseUrlhttpClient.ts- Added JSDoc to all exported functions and helperstoast.ts- Documented all toast utility functionsnetworkConfig.ts- Documented all configuration accessorswalletCache.ts- Added parameter/return docs to all exported functionsstellar.ts- Documented getNetwork, isWalletConnectedapiHealth.ts- Full JSDoc for all exported functions and hookswalletConnector.ts- Documented factory and display utility functionsriskSocket.ts- Added JSDoc to all public RiskSocketClient methodsfreighterErrors.ts- Documented parseFreighterError and helpershooks/ (6 files)
useInvoice.ts,useRepayInvoice.ts,useMintInvoice.ts- Full JSDocuseNetworkDetection.ts- Hook-level and function-level docsuseTxWithToast.ts- Enhanced existing documentationuseTransactionToast.tsx- Documented the hookCloses #269