Skip to content

docs: add JSDoc comments to public functions and fix lint warnings - #41

Open
oche11207-art wants to merge 1 commit into
stellar-network-builders:mainfrom
oche11207-art:docs/add-jsdoc-comments-and-fix-lint
Open

docs: add JSDoc comments to public functions and fix lint warnings#41
oche11207-art wants to merge 1 commit into
stellar-network-builders:mainfrom
oche11207-art:docs/add-jsdoc-comments-and-fix-lint

Conversation

@oche11207-art

Copy link
Copy Markdown
Contributor

Summary

Closes #30

Changes

  • Added JSDoc comments with @param/@returns to all exported functions in src/lib/ (a11y, format, i18n-types, performance, security, virtual-scroll) and src/hooks/ (useAnnounce, useFocusManagement, useLocale, usePerformanceMetrics)
  • Removed unused useEffect import from LocaleSwitcher.tsx
  • Removed unused useMemo import from a11y.ts

Verification

  • npm run lint: passes with zero warnings
  • npm run build: passes successfully

- Add JSDoc comments with @param/@returns to all exported functions in
  src/lib/ (a11y, format, i18n-types, performance, security, virtual-scroll)
  and src/hooks/ (useAnnounce, useFocusManagement, useLocale,
  usePerformanceMetrics)
- Remove unused useEffect import from LocaleSwitcher.tsx
- Remove unused useMemo import from a11y.ts

Closes stellar-network-builders#30
@Husten150

Copy link
Copy Markdown
Contributor

Summary

Closes #30

Changes

* Added JSDoc comments with @param/@returns to all exported functions in src/lib/ (a11y, format, i18n-types, performance, security, virtual-scroll) and src/hooks/ (useAnnounce, useFocusManagement, useLocale, usePerformanceMetrics)

* Removed unused useEffect import from LocaleSwitcher.tsx

* Removed unused useMemo import from a11y.ts

Verification

* npm run lint: passes with zero warnings

* npm run build: passes successfully

resolve conflict.

@Husten150

Copy link
Copy Markdown
Contributor

resolve conflict

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(docs): Create developer documentation with architecture overview, component API reference, and deployment guide

3 participants