Skip to content

Commit 4c505d8

Browse files
authored
docs: polish JSDoc comments, add language tags (#10129)
1 parent cb5cafb commit 4c505d8

File tree

48 files changed

+68
-71
lines changed

Some content is hidden

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

48 files changed

+68
-71
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export declare class AppLayoutMixinClass {
2121
* just the individual properties you want to change.
2222
*
2323
* The object has the following structure and default values:
24-
* ```
24+
* ```js
2525
* {
2626
* drawer: 'Drawer'
2727
* }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ export const AppLayoutMixin = (superclass) =>
105105
* just the individual properties you want to change.
106106
*
107107
* The object has the following structure and default values:
108-
* ```
108+
* ```js
109109
* {
110110
* drawer: 'Drawer'
111111
* }

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ export type AppLayoutEventMap = AppLayoutCustomEventMap & HTMLElementEventMap;
5555
* For best results, the component should be added to the root level of your application (i.e., as a direct child of `<body>`).
5656
*
5757
* The page should include a viewport meta tag which contains `viewport-fit=cover`, like the following:
58-
* ```
58+
* ```html
5959
* <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
6060
* ```
61+
*
6162
* This causes the viewport to be scaled to fill the device display.
62-
* To ensure that important content is displayed, use the provided css variables.
63-
* ```
64-
* --safe-area-inset-top
65-
* --safe-area-inset-right
66-
* --safe-area-inset-bottom
67-
* --safe-area-inset-left
68-
* ```
63+
* To ensure that important content is displayed, use the provided css variables:
64+
*
65+
* - `--safe-area-inset-top`
66+
* - `--safe-area-inset-right`
67+
* - `--safe-area-inset-bottom`
68+
* - `--safe-area-inset-left`
6969
*
7070
* ### Styling
7171
*

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ import { AppLayoutMixin } from './vaadin-app-layout-mixin.js';
3535
* For best results, the component should be added to the root level of your application (i.e., as a direct child of `<body>`).
3636
*
3737
* The page should include a viewport meta tag which contains `viewport-fit=cover`, like the following:
38-
* ```
38+
* ```html
3939
* <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
4040
* ```
41+
*
4142
* This causes the viewport to be scaled to fill the device display.
42-
* To ensure that important content is displayed, use the provided css variables.
43-
* ```
44-
* --safe-area-inset-top
45-
* --safe-area-inset-right
46-
* --safe-area-inset-bottom
47-
* --safe-area-inset-left
48-
* ```
43+
* To ensure that important content is displayed, use the provided css variables:
44+
*
45+
* - `--safe-area-inset-top`
46+
* - `--safe-area-inset-right`
47+
* - `--safe-area-inset-bottom`
48+
* - `--safe-area-inset-left`
4949
*
5050
* ### Styling
5151
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export declare class AvatarGroupMixinClass {
7777
* just the individual properties you want to change.
7878
*
7979
* The object has the following JSON structure and default values:
80-
* ```
80+
* ```js
8181
* {
8282
* // Translation of the anonymous user avatar tooltip.
8383
* anonymous: 'anonymous',

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export const AvatarGroupMixin = (superClass) =>
107107
* just the individual properties you want to change.
108108
*
109109
* The object has the following JSON structure and default values:
110-
* ```
110+
* ```js
111111
* {
112112
* // Translation of the anonymous user avatar tooltip.
113113
* anonymous: 'anonymous',

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export declare class AvatarMixinClass {
4848
* just the individual properties you want to change.
4949
*
5050
* The object has the following JSON structure and default values:
51-
* ```
51+
* ```js
5252
* {
5353
* // Translation of the anonymous user avatar tooltip.
5454
* anonymous: 'anonymous'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export const AvatarMixin = (superClass) =>
9696
* just the individual properties you want to change.
9797
*
9898
* The object has the following JSON structure and default values:
99-
* ```
99+
* ```js
100100
* {
101101
* // Translation of the anonymous user avatar tooltip.
102102
* anonymous: 'anonymous'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ declare class Button extends ButtonMixin(ElementMixin(ThemableMixin(HTMLElement)
4949
* which makes disabled buttons focusable and hoverable, while still
5050
* preventing them from being triggered:
5151
*
52-
* ```
52+
* ```js
5353
* // Set before any button is attached to the DOM.
5454
* window.Vaadin.featureFlags.accessibleDisabledButtons = true
5555
* ```

packages/button/src/vaadin-button.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class Button extends ButtonMixin(ElementMixin(ThemableMixin(PolylitMixin(LumoInj
7171
* which makes disabled buttons focusable and hoverable, while still
7272
* preventing them from being triggered:
7373
*
74-
* ```
74+
* ```js
7575
* // Set before any button is attached to the DOM.
7676
* window.Vaadin.featureFlags.accessibleDisabledButtons = true
7777
* ```

0 commit comments

Comments
 (0)