Skip to content

Commit 02b5663

Browse files
authored
Fix tsdoc (#174)
1 parent d5e2de9 commit 02b5663

File tree

4 files changed

+66
-6
lines changed

4 files changed

+66
-6
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "none",
3+
"comment": "Fix tsdoc",
4+
"packageName": "@adaptive-web/adaptive-web-components",
5+
"email": "47367562+bheston@users.noreply.github.com",
6+
"dependentChangeType": "none"
7+
}

packages/adaptive-web-components/docs/api-report.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,9 @@ export const badgeTemplate: (ds: DesignSystem) => ElementViewTemplate<FASTBadge>
272272
// @public
273273
export const badgeTemplateStyles: ElementStyles;
274274

275-
// @public @deprecated (undocumented)
275+
// Warning: (ae-internal-missing-underscore) The name "baseHeightMultiplier" should be prefixed with an underscore because the declaration is marked as @internal
276+
//
277+
// @internal @deprecated (undocumented)
276278
export const baseHeightMultiplier: CSSDirective;
277279

278280
// @public
@@ -841,7 +843,9 @@ export const dataGridTemplate: (ds: DesignSystem) => ElementViewTemplate<FASTDat
841843
// @public
842844
export const dataGridTemplateStyles: ElementStyles;
843845

844-
// @public @deprecated (undocumented)
846+
// Warning: (ae-internal-missing-underscore) The name "density" should be prefixed with an underscore because the declaration is marked as @internal
847+
//
848+
// @internal @deprecated (undocumented)
845849
export const density: CSSDirective;
846850

847851
// @beta
@@ -982,7 +986,9 @@ export const flipperTemplateStyles: ElementStyles;
982986
// @public
983987
export const globalStyleModules: (anatomy?: ComponentAnatomy<any, any>) => StyleModules;
984988

985-
// @public @deprecated (undocumented)
989+
// Warning: (ae-internal-missing-underscore) The name "heightNumber" should be prefixed with an underscore because the declaration is marked as @internal
990+
//
991+
// @internal @deprecated (undocumented)
986992
export const heightNumber: CSSDirective;
987993

988994
// @public

packages/adaptive-web-components/src/styles/index.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
import { css, CSSDirective } from "@microsoft/fast-element";
22

33
/**
4-
* @deprecated
4+
* @internal
5+
* @deprecated Replaced with Adaptive UI density system
56
*/
67
export const baseHeightMultiplier: CSSDirective = css.partial`8`;
78

89
/**
9-
* @deprecated
10+
* @internal
11+
* @deprecated Replaced with Adaptive UI density system
1012
*/
1113
export const density: CSSDirective = css.partial`0`;
1214

1315
/**
14-
* @deprecated
16+
* @internal
17+
* @deprecated Replaced with Adaptive UI density system
1518
*/
1619
export const heightNumber: CSSDirective = css.partial`32`;
1720

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3+
"extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
4+
"tagDefinitions": [
5+
{
6+
"tagName": "@slot",
7+
"syntaxKind": "block",
8+
"allowMultiple": true
9+
},
10+
{
11+
"tagName": "@csspart",
12+
"syntaxKind": "block",
13+
"allowMultiple": true
14+
},
15+
{
16+
"tagName": "@cssprop",
17+
"syntaxKind": "block",
18+
"allowMultiple": true
19+
},
20+
{
21+
"tagName": "@cssproperty",
22+
"syntaxKind": "block",
23+
"allowMultiple": true
24+
},
25+
{
26+
"tagName": "@event",
27+
"syntaxKind": "block",
28+
"allowMultiple": true
29+
},
30+
{
31+
"tagName": "@fires",
32+
"syntaxKind": "block",
33+
"allowMultiple": true
34+
}
35+
],
36+
"supportForTags": {
37+
"@slot": true,
38+
"@csspart": true,
39+
"@cssprop": true,
40+
"@cssproperty": true,
41+
"@event": true,
42+
"@fires": true
43+
}
44+
}

0 commit comments

Comments
 (0)