chore(docs): updated tsdoc to work with typedoc

Author: mlaursen

.eslintrc.js

@@ -27,5 +27,12 @@ module.exports = {
         '@typescript-eslint/no-unsafe-member-access': 0,
       },
     },
+    {
+      files: ['packages/*/src/index.ts'],
+      rules: {
+        // I don't know how to get @module to work but it's supported by typedoc
+        'tsdoc/syntax': 0,
+      },
+    },
   ],
 };

packages/alert/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/alert
+ */
 export * from "./Snackbar";
 export * from "./Toast";
 export * from "./MessageQueue";

packages/app-bar/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/app-bar
+ */
 export * from "./AppBar";
 export * from "./AppBarTitle";
 export * from "./AppBarNav";

packages/autocomplete/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/autocomplete
+ */
 export * from "./AutoComplete";
 export * from "./HighlightedResult";
 export * from "./useAutoComplete";

packages/avatar/src/index.ts

@@ -1 +1,4 @@
+/**
+ * @module @react-md/avatar
+ */
 export * from "./Avatar";

packages/badge/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/badge
+ */
 export * from "./Badge";
 export * from "./BadgeContainer";
 export * from "./BadgedButton";

packages/button/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/button
+ */
 export * from "./buttonThemeClassNames";
 export * from "./Button";
 export * from "./UnstyledButton";

packages/card/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/card
+ */
 export * from "./Card";
 export * from "./CardHeader";
 export * from "./CardTitle";

packages/chip/src/index.ts

@@ -1 +1,4 @@
+/**
+ * @module @react-md/chip
+ */
 export * from "./Chip";

packages/dialog/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @react-md/dialog
+ */
 export * from "./Dialog";
 export * from "./DialogHeader";
 export * from "./DialogTitle";