Skip to content

Fix TSDoc warnings in API documentation#121

Merged
kokoc merged 1 commit intomainfrom
fixing-api-documentation
Mar 13, 2026
Merged

Fix TSDoc warnings in API documentation#121
kokoc merged 1 commit intomainfrom
fixing-api-documentation

Conversation

@fe-lix-
Copy link
Contributor

@fe-lix- fe-lix- commented Mar 12, 2026

Summary

  • Replaced invalid @ignore TSDoc tags with @internal (17 occurrences across 2 files)
  • Added missing release tags (@public, @internal) to all exported symbols flagged by api-extractor
  • Fixed all TSDoc warnings when running npm run docs

Changes

packages/uix-host/src/extensions-provider/extension-registry.ts

  • Added @internal to internal interfaces: EndpointDefinition, ExtensionInfo, OperationDefinition, OperationMetadata, OperationProfile
  • Added @public to fetchExtensionsFromRegistry function

packages/uix-host-react/src/components/ExtensibleWrapper/ExtensionManagerProvider.ts

  • Replaced 7 @ignore tags with @internal for helper functions
  • Added @internal tags to: ExtensionPoint, AuthEMConfig, getExtensionRegistryBaseUrl, getExtensionManagerBaseUrl
  • Added @public tags to: ExtensionManagerExtension, ExtensionManagerConfig, AuthConfig, DiscoveryConfig, ExtensionPointId, ExtensionsProviderConfig, ExtensionProviderConfig

packages/uix-host-react/src/components/ExtensibleWrapper/UrlExtensionProvider.ts

  • Replaced 3 @ignore tags with @internal for helper functions
  • Added @public tags to: ExtUrlParams, isValidHttpUrl

packages/uix-host-react/src/components/ExtensibleWrapper/ExtensibleWrapper.tsx

  • Added @public documentation to ExtensibleWrapper component

Test plan

  • npm run docs completes with no TSDoc warnings
  • npm run lint passes
  • npm test passes (all 60 tests passing)
  • API documentation generated successfully with updated reports

🤖 Generated with Claude Code

Replaced invalid @ignore tags with @internal and added missing release tags (@public, @internal) to exported symbols. This resolves all api-extractor warnings when running npm run docs.

Changes:
- extension-registry.ts: Added @internal to internal interfaces and @public to fetchExtensionsFromRegistry
- ExtensionManagerProvider.ts: Replaced @ignore with @internal for helpers, added @public/@internal tags to all exported types
- UrlExtensionProvider.ts: Replaced @ignore with @internal, added @public to ExtUrlParams and isValidHttpUrl
- ExtensibleWrapper.tsx: Added @public documentation to ExtensibleWrapper component

Co-authored-by: Claude <noreply@anthropic.com>
Copy link
Contributor

@kokoc kokoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kokoc kokoc merged commit 2754733 into main Mar 13, 2026
4 checks passed
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.

2 participants