Skip to content

Commit cf54c35

Browse files
committed
chore(docs): updated tsdoc to work with typedoc
1 parent c5a8108 commit cf54c35

File tree

40 files changed

+125
-34
lines changed

40 files changed

+125
-34
lines changed

.eslintrc.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,12 @@ module.exports = {
2727
'@typescript-eslint/no-unsafe-member-access': 0,
2828
},
2929
},
30+
{
31+
files: ['packages/*/src/index.ts'],
32+
rules: {
33+
// I don't know how to get @module to work but it's supported by typedoc
34+
'tsdoc/syntax': 0,
35+
},
36+
},
3037
],
3138
};

packages/alert/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/alert
3+
*/
14
export * from "./Snackbar";
25
export * from "./Toast";
36
export * from "./MessageQueue";

packages/app-bar/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/app-bar
3+
*/
14
export * from "./AppBar";
25
export * from "./AppBarTitle";
36
export * from "./AppBarNav";

packages/autocomplete/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/autocomplete
3+
*/
14
export * from "./AutoComplete";
25
export * from "./HighlightedResult";
36
export * from "./useAutoComplete";

packages/avatar/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
/**
2+
* @module @react-md/avatar
3+
*/
14
export * from "./Avatar";

packages/badge/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/badge
3+
*/
14
export * from "./Badge";
25
export * from "./BadgeContainer";
36
export * from "./BadgedButton";

packages/button/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/button
3+
*/
14
export * from "./buttonThemeClassNames";
25
export * from "./Button";
36
export * from "./UnstyledButton";

packages/card/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/card
3+
*/
14
export * from "./Card";
25
export * from "./CardHeader";
36
export * from "./CardTitle";

packages/chip/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
/**
2+
* @module @react-md/chip
3+
*/
14
export * from "./Chip";

packages/dialog/src/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @module @react-md/dialog
3+
*/
14
export * from "./Dialog";
25
export * from "./DialogHeader";
36
export * from "./DialogTitle";

0 commit comments

Comments
 (0)