rename 'Structs' to 'Struct'

conterra · Apr 16, 2024 · d52abed · d52abed
1 parent 6302095
commit d52abed
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git 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
@@ -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<T, Params extends any[], Ret> {
     /**
@@ -46,7 +46,7 @@ export interface MethodMemberType<T, Params extends any[], Ret> {
 /**
  * A computed property of reactive struct.
  * 
- * @group Structs
+ * @group Struct
  */
 export interface ComputedMemberType<T, V> {
     /**
@@ -64,7 +64,7 @@ export interface ComputedMemberType<T, V> {
  * All properties of T must be part of the definition.
  * 
  * @param T The type of the struct.
- * @group Structs
+ * @group Struct
  */
 export type ReactiveStructDefinition<T> = {
     [key in keyof T]-?: GetMemberSchemaForProp<T, T[key]>;
@@ -97,7 +97,7 @@ type GetMemberSchemaForProp<T, V> = V extends AnyFunc
  * 
  * @param T The type of the struct.
  * @param Def The definition of the struct.
- * @group Structs
+ * @group Struct
  */
 export interface ReactiveStructConstructor<T, Def> {
     /**
@@ -147,7 +147,7 @@ type PickOptionalProps<T> = {
 /**
  * Used to build reactive structs using a struct definition.
  * 
- * @group Structs
+ * @group Struct
  */
 export interface ReactiveStructBuilder<T> {
     /**
@@ -303,7 +303,7 @@ export interface ReactiveStructBuilder<T> {
  * });
  * person.printName(); // prints "John Doe"  
  * ```
- * @group Structs
+ * @group Struct
  */
 export function reactiveStruct<T>(): ReactiveStructBuilder<T> {
     return {

diff --git 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", "*"]
 }