Skip to content

Conversation

@H4ze
Copy link
Collaborator

@H4ze H4ze commented Oct 1, 2025

No description provided.

@H4ze H4ze requested review from Thodd and petermuessig October 1, 2025 15:19
@petermuessig
Copy link
Member

petermuessig commented Oct 2, 2025

@H4ze @Thodd with that approach we can at least control either: @privateand @public but what about adding @experimental + eventuall a text and @ui5-restricted + eventuall a text ?

Maybe for that we add two more pluginOptions:

  • isExperimental with type boolean|string (boolean means @experimental tag added without text and with a string value you can define the text to set?)
  • isUI5Restricted with type boolean|string (boolean means @ui5-restricted tag added without text and with a string value you can define the text to set?)

WDYT?

@H4ze
Copy link
Collaborator Author

H4ze commented Oct 2, 2025

@H4ze @Thodd with that approach we can at least control either: @privateand @public but what about adding @experimental + eventuall a text and @ui5-restricted + eventuall a text ?

Maybe for that we add two more pluginOptions:

  • isExperimental with type boolean|string (boolean means @experimental tag added without text and with a string value you can define the text to set?)
  • isUI5Restricted with type boolean|string (boolean means @ui5-restricted tag added without text and with a string value you can define the text to set?)

WDYT?

Hmm I'm not sure about the use-cases.
experimental would also already work just without additional text. Is there really an additional text needed?
For ui5-restricted I thought about visibilityJSDoc: [my.lib.a, my.lib.b] in order to add @private and @ui5-restricted my.lib.a, my.lib.b.

@codeworrior
Copy link
Collaborator

Since 1.139, @experimental should no longer be used, use @ui5-experimental-since instead (which does not support a text, btw). See "Guidelines+for+experimental+APIs" in the UI wiki space.

Copy link
Member

@petermuessig petermuessig left a comment

Choose a reason for hiding this comment

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

LGTM - let's merge this one for now

@petermuessig petermuessig merged commit 7720c3f into main Oct 7, 2025
5 checks passed
@petermuessig petermuessig deleted the feat/make-jsdoc-visibility-configurable branch October 7, 2025 20:55
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.

4 participants