Skip to content

docs: remove type JSDoc annotation for string enum properties#11264

Merged
web-padawan merged 1 commit intomainfrom
docs/remove-enums-type
Mar 6, 2026
Merged

docs: remove type JSDoc annotation for string enum properties#11264
web-padawan merged 1 commit intomainfrom
docs/remove-enums-type

Conversation

@web-padawan
Copy link
Member

Description

Removed @type JSDoc annotation for string properties whose values are enums. These are currently not consistent:

  • orientation property had the annotation in vaadin-tabs but not in vaadin-split-layout,
  • position property had the annotation in vaadin-notification but not in vaadin-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 attributes in the output due to custom logic we have. It's better to have them listed as string instead.

Type of change

  • Documentation

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 6, 2026

@web-padawan web-padawan removed the request for review from sissbruecker March 6, 2026 10:08
@web-padawan web-padawan merged commit c39961c into main Mar 6, 2026
10 checks passed
@web-padawan web-padawan deleted the docs/remove-enums-type branch March 6, 2026 10:09
@vaadin-bot
Copy link
Collaborator

This ticket/PR has been released with Vaadin 25.1.0-beta3.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants