Skip to content

Commit f5b583e

Browse files
committed
docs: update JSDoc comments
1 parent 7cd19f2 commit f5b583e

File tree

7 files changed

+52
-11
lines changed

7 files changed

+52
-11
lines changed

src/components/progress/CProgress.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const CProgress = defineComponent({
66
name: 'CProgress',
77
props: {
88
/**
9-
* Sets the height of the component. If you set that value the inner <CProgressBar> will automatically resize accordingly.
9+
* Sets the height of the component. If you set that value the inner `<CProgressBar>` will automatically resize accordingly.
1010
*
1111
* @default 'undefined'
1212
*/

src/components/widgets/CWidgetStatsA.ts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,32 @@ const CWidgetStatsA = defineComponent({
1111
require: false,
1212
},
1313
/**
14-
* Title node for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
14+
* Title for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
1515
*/
1616
title: {
1717
type: String,
1818
default: undefined,
1919
require: false,
2020
},
2121
/**
22-
* Value node for your component. If you want to pass non-string value please use dedicated slot `<template #value>...</template>`
22+
* Value for your component. If you want to pass non-string or non-number value please use dedicated slot `<template #value>...</template>`
2323
*/
2424
value: {
2525
type: [Number, String],
2626
default: 0,
2727
require: false,
2828
},
2929
},
30+
/**
31+
* Location for action component, ex. `<CDropdown>`.
32+
*
33+
* @slot action
34+
*/
35+
/**
36+
* Location for chart component.
37+
*
38+
* @slot chart
39+
*/
3040
setup(props, { slots }) {
3141
return () =>
3242
h(
@@ -61,9 +71,15 @@ const CWidgetStatsA = defineComponent({
6171
},
6272
),
6373
]),
74+
/**
75+
* @slot Location for action component, ex. `<CDropdown>`.
76+
*/
6477
slots.action && slots.action(),
6578
],
6679
),
80+
/**
81+
* @slot Location for chart component.
82+
*/
6783
slots.chart && slots.chart(),
6884
slots.default && slots.default(),
6985
],

src/components/widgets/CWidgetStatsB.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ const CWidgetStatsB = defineComponent({
4747
require: false,
4848
},
4949
/**
50-
* Title node for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
50+
* Title for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
5151
*/
5252
title: {
5353
type: String,
5454
default: undefined,
5555
require: false,
5656
},
5757
/**
58-
* Value node for your component. If you want to pass non-string value please use dedicated slot `<template #value>...</template>`
58+
* Value for your component. If you want to pass non-string or non-number value please use dedicated slot `<template #value>...</template>`
5959
*/
6060
value: {
6161
type: [Number, String],

src/components/widgets/CWidgetStatsC.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,27 @@ const CWidgetStatsC = defineComponent({
3939
},
4040
}),
4141
/**
42-
* Title node for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
42+
* Title for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
4343
*/
4444
title: {
4545
type: String,
4646
default: undefined,
4747
require: false,
4848
},
4949
/**
50-
* Value node for your component. If you want to pass non-string value please use dedicated slot `<template #value>...</template>`
50+
* Value for your component. If you want to pass non-string or non-number value please use dedicated slot `<template #value>...</template>`
5151
*/
5252
value: {
5353
type: [Number, String],
5454
default: 0,
5555
require: false,
5656
},
5757
},
58+
/**
59+
* Location for icon component.
60+
*
61+
* @slot icon
62+
*/
5863
setup(props, { slots }) {
5964
return () =>
6065
h(

src/components/widgets/CWidgetStatsD.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ const CWidgetStatsD = defineComponent({
2222
require: false,
2323
},
2424
},
25+
/**
26+
* Location for icon component, ex. `<CDropdown>`.
27+
*
28+
* @slot icon
29+
*/
30+
/**
31+
* Location for chart component.
32+
*
33+
* @slot chart
34+
*/
2535
setup(props, { slots }) {
2636
return () =>
2737
h(

src/components/widgets/CWidgetStatsE.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,27 @@ const CWidgetStatsE = defineComponent({
66
name: 'CWidgetStatsE',
77
props: {
88
/**
9-
* Title node for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
9+
* Title for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
1010
*/
1111
title: {
1212
type: String,
1313
default: undefined,
1414
require: false,
1515
},
1616
/**
17-
* Value node for your component. If you want to pass non-string value please use dedicated slot `<template #value>...</template>`
17+
* Value for your component. If you want to pass non-string or non-number value please use dedicated slot `<template #value>...</template>`
1818
*/
1919
value: {
2020
type: [Number, String],
2121
default: 0,
2222
require: false,
2323
},
2424
},
25+
/**
26+
* Location for chart component.
27+
*
28+
* @slot chart
29+
*/
2530
setup(props, { slots }) {
2631
return () =>
2732
h(CCard, {}, () =>

src/components/widgets/CWidgetStatsF.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const CWidgetStatsF = defineComponent({
2020
default: true,
2121
},
2222
/**
23-
* Title node for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
23+
* Title for your component. If you want to pass non-string value please use dedicated slot `<template #title>...</template>`
2424
*/
2525
title: {
2626
type: String,
@@ -36,14 +36,19 @@ const CWidgetStatsF = defineComponent({
3636
require: false,
3737
},
3838
/**
39-
* Value node for your component. If you want to pass non-string value please use dedicated slot `<template #value>...</template>`
39+
* Value for your component. If you want to pass non-string or non-number value please use dedicated slot `<template #value>...</template>`
4040
*/
4141
value: {
4242
type: [Number, String],
4343
default: 0,
4444
require: false,
4545
},
4646
},
47+
/**
48+
* Location for icon component.
49+
*
50+
* @slot icon
51+
*/
4752
setup(props, { slots }) {
4853
return () =>
4954
h(

0 commit comments

Comments
 (0)