Skip to content

Commit 509f88e

Browse files
authored
docs: add customElement JSDoc annotations to classes (#6516)
1 parent e5c179c commit 509f88e

132 files changed

Lines changed: 148 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/accordion/src/vaadin-accordion-heading.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
4242
*
4343
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4444
*
45+
* @customElement
4546
* @extends HTMLElement
4647
* @mixes ActiveMixin
4748
* @mixes DirMixin

‎packages/accordion/src/vaadin-accordion-panel.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
3838
*
3939
* @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
4040
*
41+
* @customElement
4142
* @extends HTMLElement
4243
* @mixes CollapsibleMixin
4344
* @mixes ControllerMixin

‎packages/accordion/src/vaadin-accordion.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ import { AccordionPanel } from './vaadin-accordion-panel.js';
5656
* @fires {CustomEvent} items-changed - Fired when the `items` property changes.
5757
* @fires {CustomEvent} opened-changed - Fired when the `opened` property changes.
5858
*
59+
* @customElement
5960
* @extends HTMLElement
6061
* @mixes ElementMixin
6162
* @mixes KeyboardDirectionMixin

‎packages/app-layout/src/vaadin-app-layout.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
105105
* @fires {CustomEvent} overlay-changed - Fired when the `overlay` property changes.
106106
* @fires {CustomEvent} primary-section-changed - Fired when the `primarySection` property changes.
107107
*
108+
* @customElement
108109
* @extends HTMLElement
109110
* @mixes ElementMixin
110111
* @mixes ThemableMixin

‎packages/app-layout/src/vaadin-drawer-toggle.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ registerStyles(
6363
* </vaadin-app-layout>
6464
* ```
6565
*
66+
* @customElement
6667
* @extends Button
6768
*/
6869
class DrawerToggle extends Button {

‎packages/avatar-group/src/vaadin-avatar-group-menu-item.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1212
/**
1313
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
1414
*
15+
* @customElement
1516
* @extends HTMLElement
1617
* @mixes DirMixin
1718
* @mixes ItemMixin

‎packages/avatar-group/src/vaadin-avatar-group-menu.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1313
/**
1414
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
1515
*
16+
* @customElement
1617
* @extends HTMLElement
1718
* @mixes ControllerMixin
1819
* @mixes DirMixin

‎packages/avatar-group/src/vaadin-avatar-group-overlay.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ registerStyles('vaadin-avatar-group-overlay', [overlayStyles], {
1818
/**
1919
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
2020
*
21+
* @customElement
2122
* @extends HTMLElement
2223
* @mixes PositionMixin
2324
* @mixes OverlayMixin

‎packages/avatar-group/src/vaadin-avatar-group.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ const MINIMUM_DISPLAYED_AVATARS = 2;
6262
* - `<vaadin-avatar-group-menu>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
6363
* - `<vaadin-avatar-group-menu-item>` - has the same API as [`<vaadin-item>`](#/elements/vaadin-item).
6464
*
65+
* @customElement
6566
* @extends HTMLElement
6667
* @mixes ControllerMixin
6768
* @mixes ElementMixin

‎packages/avatar/src/vaadin-avatar.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ registerStyles('vaadin-avatar', avatarStyles, { moduleId: 'vaadin-avatar-styles'
4141
*
4242
* See [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.
4343
*
44+
* @customElement
4445
* @extends HTMLElement
4546
* @mixes AvatarMixin
4647
* @mixes ControllerMixin

0 commit comments

Comments
 (0)