Skip to content

docs: add customElement JSDoc annotations to classes - #6516

Merged
web-padawan merged 1 commit into
mainfrom
docs/add-element-jsdoc
Sep 22, 2023
Merged

web-padawan merged 1 commit into
mainfrom
docs/add-element-jsdoc

Conversation

@web-padawan

Copy link
Copy Markdown
Member

Description

This PR fixes a docs generation issue introduced in #6509 where we replaced customElements.define() with a helper.
In order to make polymer-analyzer work, we now have to add @customElement annotations to all classes.

Here's the relevant logic in the analyzer source code. Note, the tag name is determined based on static get is().

Type of change

  • Docs

@web-padawan
web-padawan requested a review from vursen September 22, 2023 08:29
@sonarqubecloud

Copy link
Copy Markdown

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@vaadin-bot

Copy link
Copy Markdown
Collaborator

This ticket/PR has been released with Vaadin 24.2.0.beta1 and is also targeting the upcoming stable 24.2.0 version.

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