diff --git a/packages/reactivity-core/index.ts b/packages/reactivity-core/index.ts index 2b2a8bd..a9b0490 100644 --- a/packages/reactivity-core/index.ts +++ b/packages/reactivity-core/index.ts @@ -15,9 +15,9 @@ * * Reactive collections to simplify working with complex data structures. * - * @groupDescription Structs + * @groupDescription Struct * - * Create class like objects having reactive properties. + * Utilities to create reactive data structures/objects. */ export { type ReadonlyReactive, diff --git a/packages/reactivity-core/struct/struct.ts b/packages/reactivity-core/struct/struct.ts index 7e6ba85..24b5092 100644 --- a/packages/reactivity-core/struct/struct.ts +++ b/packages/reactivity-core/struct/struct.ts @@ -5,7 +5,7 @@ import { computed, getValue, isWritableReactive, reactive } from "../ReactiveImp /** * A property of a reactive struct. * - * @group Structs + * @group Struct */ export interface PropertyMemberType { /** @@ -30,7 +30,7 @@ export interface PropertyMemberType { /** * A method of a reactive struct. * - * @group Structs + * @group Struct */ export interface MethodMemberType { /** @@ -46,7 +46,7 @@ export interface MethodMemberType { /** * A computed property of reactive struct. * - * @group Structs + * @group Struct */ export interface ComputedMemberType { /** @@ -64,7 +64,7 @@ export interface ComputedMemberType { * All properties of T must be part of the definition. * * @param T The type of the struct. - * @group Structs + * @group Struct */ export type ReactiveStructDefinition = { [key in keyof T]-?: GetMemberSchemaForProp; @@ -97,7 +97,7 @@ type GetMemberSchemaForProp = V extends AnyFunc * * @param T The type of the struct. * @param Def The definition of the struct. - * @group Structs + * @group Struct */ export interface ReactiveStructConstructor { /** @@ -147,7 +147,7 @@ type PickOptionalProps = { /** * Used to build reactive structs using a struct definition. * - * @group Structs + * @group Struct */ export interface ReactiveStructBuilder { /** @@ -303,7 +303,7 @@ export interface ReactiveStructBuilder { * }); * person.printName(); // prints "John Doe" * ``` - * @group Structs + * @group Struct */ export function reactiveStruct(): ReactiveStructBuilder { return { diff --git a/packages/reactivity-core/typedoc.json b/packages/reactivity-core/typedoc.json index 96a5045..e302b50 100644 --- a/packages/reactivity-core/typedoc.json +++ b/packages/reactivity-core/typedoc.json @@ -2,5 +2,5 @@ // project-root is a dev dependency (link to the project root) "extends": ["project-root/typedoc.base.json"], "entryPoints": ["./index.ts"], - "groupOrder": ["Primitives", "Watching", "Collections", "Structs", "*"] + "groupOrder": ["Primitives", "Watching", "Collections", "Struct", "*"] }