docs: remove type JSDoc annotation for string enum properties#11264
Merged
web-padawan merged 1 commit intomainfrom Mar 6, 2026
Merged
docs: remove type JSDoc annotation for string enum properties#11264web-padawan merged 1 commit intomainfrom
web-padawan merged 1 commit intomainfrom
Conversation
|
vursen
approved these changes
Mar 6, 2026
Collaborator
|
This ticket/PR has been released with Vaadin 25.1.0-beta3. |
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
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.



Description
Removed
@typeJSDoc annotation for string properties whose values are enums. These are currently not consistent:orientationproperty had the annotation invaadin-tabsbut not invaadin-split-layout,positionproperty had the annotation invaadin-notificationbut not invaadin-popover.Also, for API docs we generally don't use these as the script instead looks up for type definitions to resolve proper type.
The main problem with these is that CEM analyzer treats such properties as non-primitive types and therefore removes them from
attributesin the output due to custom logic we have. It's better to have them listed asstringinstead.Type of change