Skip to content

Commit f889883

Browse files
authored
docs: improve code snippets in JSDoc comments, add language tags (#9697)
1 parent d60146d commit f889883

Some content is hidden

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

44 files changed

+100
-108
lines changed

packages/accordion/src/vaadin-accordion.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export type AccordionEventMap = AccordionCustomEventMap & HTMLElementEventMap;
3838
* Only one panel can be opened at a time, opening a new one forces
3939
* previous panel to close and hide its content.
4040
*
41-
* ```
41+
* ```html
4242
* <vaadin-accordion>
4343
* <vaadin-accordion-panel>
4444
* <vaadin-accordion-heading slot="summary">Panel 1</vaadin-accordion-heading>

packages/accordion/src/vaadin-accordion.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { AccordionMixin } from './vaadin-accordion-mixin.js';
2323
* Only one panel can be opened at a time, opening a new one forces
2424
* previous panel to close and hide its content.
2525
*
26-
* ```
26+
* ```html
2727
* <vaadin-accordion>
2828
* <vaadin-accordion-panel>
2929
* <vaadin-accordion-heading slot="summary">Panel 1</vaadin-accordion-heading>

packages/app-layout/src/vaadin-app-layout.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export type AppLayoutEventMap = AppLayoutCustomEventMap & HTMLElementEventMap;
3737
/**
3838
* `<vaadin-app-layout>` is a Web Component providing a quick and easy way to get a common application layout structure done.
3939
*
40-
* ```
40+
* ```html
4141
* <vaadin-app-layout primary-section="navbar|drawer">
4242
* <vaadin-drawer-toggle slot="navbar [touch-optimized]"></vaadin-drawer-toggle>
4343
* <h3 slot="navbar [touch-optimized]">Company Name</h3>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { AppLayoutMixin } from './vaadin-app-layout-mixin.js';
1717
/**
1818
* `<vaadin-app-layout>` is a Web Component providing a quick and easy way to get a common application layout structure done.
1919
*
20-
* ```
20+
* ```html
2121
* <vaadin-app-layout primary-section="navbar|drawer">
2222
* <vaadin-drawer-toggle slot="navbar [touch-optimized]"></vaadin-drawer-toggle>
2323
* <h3 slot="navbar [touch-optimized]">Company Name</h3>

packages/app-layout/src/vaadin-drawer-toggle.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
1010
/**
1111
* The Drawer Toggle component controls the drawer in App Layout component.
1212
*
13-
* ```
13+
* ```html
1414
* <vaadin-app-layout>
1515
* <vaadin-drawer-toggle slot="navbar">Toggle drawer</vaadin-drawer-toggle>
1616
* </vaadin-app-layout>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { drawerToggle } from './styles/vaadin-drawer-toggle-core-styles.js';
1717
/**
1818
* The Drawer Toggle component controls the drawer in App Layout component.
1919
*
20-
* ```
20+
* ```html
2121
* <vaadin-app-layout>
2222
* <vaadin-drawer-toggle slot="navbar">Toggle drawer</vaadin-drawer-toggle>
2323
* </vaadin-app-layout>

packages/avatar-group/src/vaadin-avatar-group.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ export { AvatarGroupI18n, AvatarGroupItem, AvatarI18n };
1515
*
1616
* To create the avatar group, first add the component to the page:
1717
*
18-
* ```
18+
* ```html
1919
* <vaadin-avatar-group></vaadin-avatar-group>
2020
* ```
2121
*
2222
* And then use [`items`](#/elements/vaadin-avatar-group#property-items) property to initialize the structure:
2323
*
24-
* ```
24+
* ```js
2525
* document.querySelector('vaadin-avatar-group').items = [
2626
* {name: 'John Doe'},
2727
* {abbr: 'AB'}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ import { AvatarGroupMixin } from './vaadin-avatar-group-mixin.js';
2222
*
2323
* To create the avatar group, first add the component to the page:
2424
*
25-
* ```
25+
* ```html
2626
* <vaadin-avatar-group></vaadin-avatar-group>
2727
* ```
2828
*
2929
* And then use [`items`](#/elements/vaadin-avatar-group#property-items) property to initialize the structure:
3030
*
31-
* ```
31+
* ```js
3232
* document.querySelector('vaadin-avatar-group').items = [
3333
* {name: 'John Doe'},
3434
* {abbr: 'AB'}

packages/confirm-dialog/src/vaadin-confirm-dialog.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export * from './vaadin-confirm-dialog-mixin.js';
1212
/**
1313
* `<vaadin-confirm-dialog>` is a Web Component for showing alerts and asking for user confirmation.
1414
*
15-
* ```
15+
* ```html
1616
* <vaadin-confirm-dialog cancel-button-visible>
1717
* There are unsaved changes. Do you really want to leave?
1818
* </vaadin-confirm-dialog>

packages/confirm-dialog/src/vaadin-confirm-dialog.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { ConfirmDialogMixin } from './vaadin-confirm-dialog-mixin.js';
1616
/**
1717
* `<vaadin-confirm-dialog>` is a Web Component for showing alerts and asking for user confirmation.
1818
*
19-
* ```
19+
* ```html
2020
* <vaadin-confirm-dialog cancel-button-visible>
2121
* There are unsaved changes. Do you really want to leave?
2222
* </vaadin-confirm-dialog>

0 commit comments

Comments
 (0)