Skip to content

Commit 8388c4d

Browse files
authored
chore: add @description tags (#12063)
add them so that the TypeScript parser doesn't put the following content under the `@deprecated` tag, which messes with the JSON-type-generation script.
1 parent 4ddff6f commit 8388c4d

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

packages/svelte/src/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ export class SvelteComponentTyped<
170170
/**
171171
* @deprecated The new `Component` type does not have a dedicated Events type. Use `ComponentProps` instead.
172172
*
173+
* @description
173174
* Convenience type to get the events the given component expects. Example:
174175
* ```html
175176
* <script lang="ts">
@@ -208,6 +209,7 @@ export type ComponentProps<Comp extends SvelteComponent | Component<any>> =
208209
/**
209210
* @deprecated This type is obsolete when working with the new `Component` type.
210211
*
212+
* @description
211213
* Convenience type to get the type of a Svelte component. Useful for example in combination with
212214
* dynamic components using `<svelte:component>`.
213215
*

packages/svelte/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ declare module 'svelte' {
167167
/**
168168
* @deprecated The new `Component` type does not have a dedicated Events type. Use `ComponentProps` instead.
169169
*
170+
* @description
170171
* Convenience type to get the events the given component expects. Example:
171172
* ```html
172173
* <script lang="ts">
@@ -205,6 +206,7 @@ declare module 'svelte' {
205206
/**
206207
* @deprecated This type is obsolete when working with the new `Component` type.
207208
*
209+
* @description
208210
* Convenience type to get the type of a Svelte component. Useful for example in combination with
209211
* dynamic components using `<svelte:component>`.
210212
*

0 commit comments

Comments
 (0)