Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add dashboard jsdocs #7891

Merged
merged 9 commits into from
Oct 1, 2024
Merged

Conversation

ugur-vaadin
Copy link
Contributor

Description

This PR adds JSDocs for

  • Dashboard
  • Dashboard layout
  • Dashboard widget
  • Dashboard section

Part of vaadin/platform#6626

Type of change

Docs/Chore

Copy link
Member

@web-padawan web-padawan left a comment

Choose a reason for hiding this comment

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

Not directly related to this PR but consider also adding @attr annotations to camel-case properties for VSCode Lit plugin code completion:

@attr {string} widget-title
@attr {string} section-title
@attr {boolean} dense-layout

@ugur-vaadin
Copy link
Contributor Author

@attr {string} widget-title

Done.

@ugur-vaadin ugur-vaadin force-pushed the feat/dashboard-jsdocs branch from 0a9cbc4 to fd47d5a Compare October 1, 2024 12:31
Copy link

sonarqubecloud bot commented Oct 1, 2024

@ugur-vaadin ugur-vaadin merged commit f992988 into feat/dashboard Oct 1, 2024
9 checks passed
@ugur-vaadin ugur-vaadin deleted the feat/dashboard-jsdocs branch October 1, 2024 12:32
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