Visualize Your Ideas With Code
docs: add module descriptions
aarthificial93a65550f4c6
diff --git a/packages/core/src/decorators/index.ts b/packages/core/src/decorators/index.tsindex a0d825b0..f2b524be 100644--- a/packages/core/src/decorators/index.ts+++ b/packages/core/src/decorators/index.ts@@ -1,2 +1,8 @@+/**+ * Property decorators.+ *+ * @packageDocumentation+ */+export * from './decorate';export * from './threadable';diff --git a/packages/core/src/events/index.ts b/packages/core/src/events/index.tsindex 69cee33e..8f0365c8 100644--- a/packages/core/src/events/index.ts+++ b/packages/core/src/events/index.ts@@ -1,3 +1,9 @@+/**+ * Subscriptions and triggering of events.+ *+ * @packageDocumentation+ */+export * from './AsyncEventDispatcher';export * from './EventDispatcher';export * from './EventDispatcherBase';diff --git a/packages/core/src/index.ts b/packages/core/src/index.tsindex 62e8e8fb..1ce96aea 100644--- a/packages/core/src/index.ts+++ b/packages/core/src/index.ts@@ -1,3 +1,9 @@+/**+ * Main Motion Canvas classes.+ *+ * @packageDocumentation+ */+export * from './Logger';export * from './Meta';export * from './Project';diff --git a/packages/core/src/media/index.ts b/packages/core/src/media/index.tsindex 69713b72..721c5492 100644--- a/packages/core/src/media/index.ts+++ b/packages/core/src/media/index.ts@@ -1,3 +1,9 @@+/**+ * Multi-media management.+ *+ * @packageDocumentation+ */+export * from './AudioData';export * from './AudioManager';export * from './loadImage';diff --git a/packages/core/src/player/index.ts b/packages/core/src/player/index.tsindex 3d0862b6..acb7e481 100644--- a/packages/core/src/player/index.ts+++ b/packages/core/src/player/index.ts@@ -1 +1,7 @@+/**+ * Playback control.+ *+ * @packageDocumentation+ */+export * from './Player';diff --git a/packages/core/src/scenes/index.ts b/packages/core/src/scenes/index.tsindex 8c35e413..343715da 100644--- a/packages/core/src/scenes/index.ts+++ b/packages/core/src/scenes/index.ts@@ -1,3 +1,9 @@+/**+ * Abstract scene representations and related utilities.+ *+ * @packageDocumentation+ */+export * from './GeneratorScene';export * from './Inspectable';export * from './Random';diff --git a/packages/core/src/transitions/index.ts b/packages/core/src/transitions/index.tsindex 5164b00c..efa0622c 100644--- a/packages/core/src/transitions/index.ts+++ b/packages/core/src/transitions/index.ts@@ -1,2 +1,8 @@+/**+ * Transitions between scenes.+ *+ * @packageDocumentation+ */+export * from './slideTransition';export * from './useTransition';diff --git a/packages/core/src/tweening/index.ts b/packages/core/src/tweening/index.tsindex b3b7da2b..85d0f5ea 100644--- a/packages/core/src/tweening/index.ts+++ b/packages/core/src/tweening/index.ts@@ -1,3 +1,9 @@+/**+ * Interpolation and timing of tweens.+ *+ * @packageDocumentation+ */+export * from './interpolationFunctions';export * from './timingFunctions';export * from './tween';diff --git a/packages/core/src/types/index.ts b/packages/core/src/types/index.tsindex 5b296996..e02181bd 100644--- a/packages/core/src/types/index.ts+++ b/packages/core/src/types/index.ts@@ -1,3 +1,9 @@+/**+ * Complex types used in animations.+ *+ * @packageDocumentation+ */+export * from './Canvas';export * from './Color';export * from './Matrix';diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.tsindex eb8b5857..5c088461 100644--- a/packages/core/src/utils/index.ts+++ b/packages/core/src/utils/index.ts@@ -1,3 +1,9 @@+/**+ * General utilities and helper functions.+ *+ * @packageDocumentation+ */+export * from './capitalize';export * from './getContext';export * from './range';diff --git a/packages/docs/sidebars.js b/packages/docs/sidebars.jsindex 53f79e57..0b0af318 100644--- a/packages/docs/sidebars.js+++ b/packages/docs/sidebars.js@@ -1,47 +1,5 @@// @ts-check-function createApiSidebar(name) {- return [- {- type: 'category',- label: 'Modules',- collapsed: false,- link: {- type: 'generated-index',- slug: name,- },- items: [{type: 'autogenerated', dirName: `${name}/modules`}],- },- {- type: 'category',- label: 'Classes',- link: {- type: 'generated-index',- slug: `${name}/classes`,- },- items: [{type: 'autogenerated', dirName: `${name}/classes`}],- },- {- type: 'category',- label: 'Enumerations',- link: {- type: 'generated-index',- slug: `${name}/enums`,- },- items: [{type: 'autogenerated', dirName: `${name}/enums`}],- },- {- type: 'category',- label: 'Interfaces',- link: {- type: 'generated-index',- slug: `${name}/interfaces`,- },- items: [{type: 'autogenerated', dirName: `${name}/interfaces`}],- },- ];-}-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */const sidebars = {guides: [{type: 'autogenerated', dirName: 'guides'}],diff --git a/packages/docs/src/components/Api/ApiItem.tsx b/packages/docs/src/components/Api/ApiItem.tsxindex bab28924..64f55b4a 100644--- a/packages/docs/src/components/Api/ApiItem.tsx+++ b/packages/docs/src/components/Api/ApiItem.tsx@@ -10,6 +10,7 @@ import {matchFilters, useFilters} from '@site/src/contexts/filters';import {TOCItem} from '@docusaurus/mdx-loader';import Tooltip from '@site/src/components/Tooltip';import type {JSONOutput} from 'typedoc';+import {ReflectionKind} from './ReflectionKind';interface ApiItemProps {route: {@@ -26,7 +27,7 @@ export default function ApiItem({route}: ApiItemProps): JSX.Element {const [filters] = useFilters();const toc = useMemo(() => {const toc: TOCItem[] = [];- if (!reflection.groups) {+ if (!reflection.groups || reflection.kind === ReflectionKind.Project) {return toc;}diff --git a/packages/docs/typedoc.js b/packages/docs/typedoc.jsindex 0a250c7b..3d056fed 100644--- a/packages/docs/typedoc.js+++ b/packages/docs/typedoc.js@@ -28,6 +28,7 @@ module.exports = () => ({'../core/src/media','../core/src/player','../core/src/scenes',+ '../core/src/signals','../core/src/threading','../core/src/transitions','../core/src/tweening',