Skip to content

Conversation

@petermuessig
Copy link
Member

This PR adds support for generic additional jsdoc tags for the documentation of the Seamless Wrappers.

In the ui5.yaml you can specify the additional tags in the pluginOptionswebcomponentsadditionalJSDocTags section:

builder:
  customTasks:
    - name: ui5-tooling-modules-task
      afterTask: ui5-tooling-transpile-task
      configuration:
        pluginOptions:
          webcomponents:
            additionalJSDocTags:
              - ui5-restricted ui5.ecosystem.demo.tsapp

The configuration option expects and array of strings whereas the first connected string literal is seen as the JSDoc tag which will be prefixed with an @.

With that feature we can easily control the JSDoc of the Seamless Wrappers in a very generic way.

In addition, I also corrected a bit the alignment and the not needed new lines in the resulting JSDoc to make it looking more streamlined.

@petermuessig petermuessig requested review from H4ze and Thodd October 12, 2025 09:17
H4ze
H4ze previously approved these changes Oct 13, 2025
Copy link
Collaborator

@H4ze H4ze left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Collaborator

@H4ze H4ze left a comment

Choose a reason for hiding this comment

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

lgtm

@petermuessig petermuessig merged commit 66d4538 into main Oct 14, 2025
5 checks passed
@petermuessig petermuessig deleted the feat/modules/AdditionalJSDocTags branch October 14, 2025 05:26
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.

3 participants