chore: adds tsdoc comments to fast-components-msft (#3332)

* api report * update all exports * add doc process to ci * pretty pretty * update docs
microsoft · Jun 18, 2020 · 8050a3d · 8050a3d
1 parent 599b6ca
commit 8050a3d
Show file tree

Hide file tree

Showing 35 changed files with 1,309 additions and 2,554 deletions.
diff --git a/packages/web-components/fast-components-msft/docs/api-report.md b/packages/web-components/fast-components-msft/docs/api-report.md
diff --git a/packages/web-components/fast-components-msft/package.json b/packages/web-components/fast-components-msft/package.json
@@ -21,6 +21,7 @@
   "scripts": {
     "clean:dist": "node ../../../build/clean.js dist",
     "doc": "api-extractor run --local",
+    "doc:ci": "api-extractor run --local",
     "build": "tsc -p ./tsconfig.json && rollup -c && npm run doc",
     "dev": "tsc -p ./tsconfig.json -w",
     "tdd": "npm run dev & npm run test-chrome:watch",
@@ -31,7 +32,7 @@
     "eslint:fix": "eslint . --ext .ts --fix",
     "start": "start-storybook -p 6006",
     "build-storybook": "build-storybook",
-    "test": "npm run test-chrome:verbose",
+    "test": "yarn test-chrome:verbose && yarn doc:ci",
     "test-node": "mocha --reporter min --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'",
     "test-node:verbose": "mocha --reporter spec --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'",
     "test-chrome": "karma start karma.conf.js --browsers=ChromeHeadlessOpt --single-run --coverage",

diff --git a/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts b/packages/web-components/fast-components-msft/src/accordion/accordion-item/index.ts
@@ -5,6 +5,15 @@ import {
 } from "@microsoft/fast-foundation";
 import { AccordionItemStyles as styles } from "./accordion-item.styles";
 
+/**
+ * The FAST Accordion Item Element. Implements {@link @microsoft/fast-foundation#AccordionItem},
+ * {@link @microsoft/fast-foundation#AccordionItemTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-accordion-item\>
+ */
 @customElement({
     name: "fast-accordion-item",
     template,

diff --git a/packages/web-components/fast-components-msft/src/accordion/index.ts b/packages/web-components/fast-components-msft/src/accordion/index.ts
@@ -4,6 +4,15 @@ import { AccordionStyles as styles } from "./accordion.styles";
 
 export * from "./accordion-item/index";
 
+/**
+ * The FAST Accordion Element. Implements {@link @microsoft/fast-foundation#Accordion},
+ * {@link @microsoft/fast-foundation#AccordionTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-accordion\>
+ */
 @customElement({
     name: "fast-accordion",
     template,

diff --git a/packages/web-components/fast-components-msft/src/anchor/index.ts b/packages/web-components/fast-components-msft/src/anchor/index.ts
@@ -2,7 +2,17 @@ import { customElement } from "@microsoft/fast-element";
 import { Anchor, AnchorTemplate as template } from "@microsoft/fast-foundation";
 import { AnchorStyles as styles } from "./anchor.styles";
 
-// Anchor
+/**
+ * The FAST Anchor Element. Implements {@link @microsoft/fast-foundation#Anchor},
+ * {@link @microsoft/fast-foundation#AnchorTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-anchor\>
+ *
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}
+ */
 @customElement({
     name: "fast-anchor",
     template,

diff --git a/packages/web-components/fast-components-msft/src/badge/index.ts b/packages/web-components/fast-components-msft/src/badge/index.ts
@@ -2,8 +2,21 @@ import { attr, customElement, DOM } from "@microsoft/fast-element";
 import { Badge, BadgeTemplate as template } from "@microsoft/fast-foundation";
 import { BadgeStyles as styles } from "./badge.styles";
 
+/**
+ * Badge appearance options.
+ * @public
+ */
 export type BadgeAppearance = "accent" | "lightweight" | "neutral" | string;
 
+/**
+ * The FAST Badge Element. Implements {@link @microsoft/fast-foundation#Badge},
+ * {@link @microsoft/fast-foundation#BadgeTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-badge\>
+ */
 @customElement({
     name: "fast-badge",
     template,

diff --git a/packages/web-components/fast-components-msft/src/button/index.ts b/packages/web-components/fast-components-msft/src/button/index.ts
@@ -2,7 +2,17 @@ import { customElement } from "@microsoft/fast-element";
 import { Button, ButtonTemplate as template } from "@microsoft/fast-foundation";
 import { ButtonStyles as styles } from "./button.styles";
 
-// Button
+/**
+ * The FAST Button Element. Implements {@link @microsoft/fast-foundation#Button},
+ * {@link @microsoft/fast-foundation#ButtonTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-button\>
+ *
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot/delegatesFocus | delegatesFocus}
+ */
 @customElement({
     name: "fast-button",
     template,

diff --git a/packages/web-components/fast-components-msft/src/card/index.ts b/packages/web-components/fast-components-msft/src/card/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Card, CardTemplate as template } from "@microsoft/fast-foundation";
 import { CardStyles as styles } from "./card.styles";
 
+/**
+ * The FAST Card Element. Implements {@link @microsoft/fast-foundation#Card},
+ * {@link @microsoft/fast-foundation#CardTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-card\>
+ */
 @customElement({
     name: "fast-card",
     template,

diff --git a/packages/web-components/fast-components-msft/src/checkbox/index.ts b/packages/web-components/fast-components-msft/src/checkbox/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Checkbox, CheckboxTemplate as template } from "@microsoft/fast-foundation";
 import { CheckboxStyles as styles } from "./checkbox.styles";
 
+/**
+ * The FAST Checkbox Element. Implements {@link @microsoft/fast-foundation#Checkbox},
+ * {@link @microsoft/fast-foundation#CheckboxTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-checkbox\>
+ */
 @customElement({
     name: "fast-checkbox",
     template,

diff --git a/packages/web-components/fast-components-msft/src/design-system-provider/index.ts b/packages/web-components/fast-components-msft/src/design-system-provider/index.ts
@@ -27,6 +27,15 @@ const backgroundStyles = css`
     }
 `.withBehaviors(color);
 
+/**
+ * The FAST DesignSystemProvider Element. Implements {@link @microsoft/fast-foundation#DesignSystemProvider},
+ * {@link @microsoft/fast-foundation#DesignSystemProviderTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-design-system-provider\>
+ */
 @designSystemProvider({
     name: "fast-design-system-provider",
     template,

diff --git a/packages/web-components/fast-components-msft/src/dialog/index.ts b/packages/web-components/fast-components-msft/src/dialog/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Dialog, DialogTemplate as template } from "@microsoft/fast-foundation";
 import { DialogStyles as styles } from "./dialog.styles";
 
+/**
+ * The FAST Dialog Element. Implements {@link @microsoft/fast-foundation#Dialog},
+ * {@link @microsoft/fast-foundation#DialogTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-dialog\>
+ */
 @customElement({
     name: "fast-dialog",
     template,

diff --git a/packages/web-components/fast-components-msft/src/divider/index.ts b/packages/web-components/fast-components-msft/src/divider/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Divider, DividerTemplate as template } from "@microsoft/fast-foundation";
 import { DividerStyles as styles } from "./divider.styles";
 
+/**
+ * The FAST Divider Element. Implements {@link @microsoft/fast-foundation#Divider},
+ * {@link @microsoft/fast-foundation#DividerTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-divider\>
+ */
 @customElement({
     name: "fast-divider",
     template,

diff --git a/packages/web-components/fast-components-msft/src/flipper/index.ts b/packages/web-components/fast-components-msft/src/flipper/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Flipper, FlipperTemplate as template } from "@microsoft/fast-foundation";
 import { FlipperStyles as styles } from "./flipper.styles";
 
+/**
+ * The FAST Flipper Element. Implements {@link @microsoft/fast-foundation#Flipper},
+ * {@link @microsoft/fast-foundation#FlipperTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-flipper\>
+ */
 @customElement({
     name: "fast-flipper",
     template,

diff --git a/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts b/packages/web-components/fast-components-msft/src/progress/progress-ring/index.ts
@@ -5,6 +5,15 @@ import {
 } from "@microsoft/fast-foundation";
 import { ProgressRingStyles as styles } from "./progress-ring.styles";
 
+/**
+ * The FAST Progress Ring Element. Implements {@link @microsoft/fast-foundation#BaseProgress},
+ * {@link @microsoft/fast-foundation#ProgressRingTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-progress-ring\>
+ */
 @customElement({
     name: "fast-progress-ring",
     template,

diff --git a/packages/web-components/fast-components-msft/src/progress/progress/index.ts b/packages/web-components/fast-components-msft/src/progress/progress/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { BaseProgress, ProgressTemplate as template } from "@microsoft/fast-foundation";
 import { ProgressStyles as styles } from "./progress.styles";
 
+/**
+ * The FAST Progress Element. Implements {@link @microsoft/fast-foundation#BaseProgress},
+ * {@link @microsoft/fast-foundation#ProgressTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-progress\>
+ */
 @customElement({
     name: "fast-progress",
     template,

diff --git a/packages/web-components/fast-components-msft/src/radio-group/index.ts b/packages/web-components/fast-components-msft/src/radio-group/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { RadioGroup, RadioGroupTemplate as template } from "@microsoft/fast-foundation";
 import { RadioGroupStyles as styles } from "./radio-group.styles";
 
+/**
+ * The FAST Radio Group Element. Implements {@link @microsoft/fast-foundation#RadioGroup},
+ * {@link @microsoft/fast-foundation#RadioGroupTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-radio-group\>
+ */
 @customElement({
     name: "fast-radio-group",
     template,

diff --git a/packages/web-components/fast-components-msft/src/radio/index.ts b/packages/web-components/fast-components-msft/src/radio/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Radio, RadioTemplate as template } from "@microsoft/fast-foundation";
 import { RadioStyles as styles } from "./radio.styles";
 
+/**
+ * The FAST Radio Element. Implements {@link @microsoft/fast-foundation#Radio},
+ * {@link @microsoft/fast-foundation#RadioTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-radio\>
+ */
 @customElement({
     name: "fast-radio",
     template,

diff --git a/packages/web-components/fast-components-msft/src/slider-label/index.ts b/packages/web-components/fast-components-msft/src/slider-label/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { SliderLabel, SliderLabelTemplate as template } from "@microsoft/fast-foundation";
 import { SliderLabelStyles as styles } from "./slider-label.styles";
 
+/**
+ * The FAST Slider Label Custom Element. Implements {@link @microsoft/fast-foundation#SliderLabel},
+ * {@link @microsoft/fast-foundation#SliderLabelTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-slider-label\>
+ */
 @customElement({
     name: "fast-slider-label",
     template,

diff --git a/packages/web-components/fast-components-msft/src/slider/index.ts b/packages/web-components/fast-components-msft/src/slider/index.ts
@@ -2,6 +2,15 @@ import { customElement } from "@microsoft/fast-element";
 import { Slider, SliderTemplate as template } from "@microsoft/fast-foundation";
 import { SliderStyles as styles } from "./slider.styles";
 
+/**
+ * The FAST Slider Custom Element. Implements {@link @microsoft/fast-foundation#Slider},
+ * {@link @microsoft/fast-foundation#SliderTemplate}
+ *
+ *
+ * @public
+ * @remarks
+ * HTML Element: \<fast-slider\>
+ */
 @customElement({
     name: "fast-slider",
     template,