From 50bd9b9f37b7a90f62c8ec76e29531763f3b1bc9 Mon Sep 17 00:00:00 2001
From: b3hr4d <behradmusiclove@yahoo.com>
Date: Fri, 16 Feb 2024 20:32:57 +0300
Subject: [PATCH] Update typedoc.json files with package names

---
 packages/store/typedoc.json                    | 2 +-
 packages/visitor/src/details/index.ts          | 6 ++++++
 packages/visitor/src/fields/index.ts           | 6 ++++++
 packages/visitor/src/random/args.ts            | 6 ++++++
 packages/visitor/src/random/response.ts        | 6 ++++++
 packages/visitor/src/transform/normal/index.ts | 6 ++++++
 packages/visitor/src/transform/table/index.ts  | 6 ++++++
 packages/visitor/typedoc.json                  | 3 ++-
 typedoc.json                                   | 1 +
 9 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/packages/store/typedoc.json b/packages/store/typedoc.json
index 8f0c301437..2e58bd853c 100644
--- a/packages/store/typedoc.json
+++ b/packages/store/typedoc.json
@@ -1,5 +1,5 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "entryPoints": ["./src"],
-  "entryPointStrategy": "resolve"
+  "name": "Store"
 }
diff --git a/packages/visitor/src/details/index.ts b/packages/visitor/src/details/index.ts
index 74d61e6108..26b2431eb9 100644
--- a/packages/visitor/src/details/index.ts
+++ b/packages/visitor/src/details/index.ts
@@ -14,6 +14,12 @@ import { FieldType } from "../types"
 
 export * from "./types"
 
+/**
+ * Visit the candid file and extract the details.
+ * It returns the extracted service details.
+ *
+ * @category Main
+ */
 export class VisitDetails<
   A extends ActorSubclass<any> = DefaultActorType
 > extends IDL.Visitor<
diff --git a/packages/visitor/src/fields/index.ts b/packages/visitor/src/fields/index.ts
index d64572ce49..f17785d685 100644
--- a/packages/visitor/src/fields/index.ts
+++ b/packages/visitor/src/fields/index.ts
@@ -29,6 +29,12 @@ import type {
 export * from "./types"
 export * from "../helper"
 
+/**
+ * Visit the candid file and extract the fields.
+ * It returns the extracted service fields.
+ *
+ * @category Main
+ */
 export class VisitFields<
   A extends ActorSubclass<any> = DefaultActorType,
   M extends FunctionName<A> = FunctionName<A>
diff --git a/packages/visitor/src/random/args.ts b/packages/visitor/src/random/args.ts
index 1b3831f2d3..9850da83ab 100644
--- a/packages/visitor/src/random/args.ts
+++ b/packages/visitor/src/random/args.ts
@@ -6,6 +6,12 @@ import {
   FunctionName,
 } from "@ic-reactor/store"
 
+/**
+ * Visit the candid file and extract the fields.
+ * It returns the extracted service fields.
+ *
+ * @category Main
+ */
 export class VisitRandomArgs<
   A extends ActorSubclass<any> = DefaultActorType
 > extends IDL.Visitor<any, any> {
diff --git a/packages/visitor/src/random/response.ts b/packages/visitor/src/random/response.ts
index 15ddcc4315..cd30e32cfe 100644
--- a/packages/visitor/src/random/response.ts
+++ b/packages/visitor/src/random/response.ts
@@ -7,6 +7,12 @@ import {
   FunctionName,
 } from "@ic-reactor/store"
 
+/**
+ * Visit the candid file and extract the fields.
+ * It returns the extracted service fields.
+ *
+ * @category Main
+ */
 export class VisitRandomResponse<
   A extends ActorSubclass<any> = DefaultActorType,
   M extends FunctionName<A> = FunctionName<A>
diff --git a/packages/visitor/src/transform/normal/index.ts b/packages/visitor/src/transform/normal/index.ts
index d01aba0939..09b98d0b9f 100644
--- a/packages/visitor/src/transform/normal/index.ts
+++ b/packages/visitor/src/transform/normal/index.ts
@@ -10,6 +10,12 @@ import type {
 
 export * from "./types"
 
+/**
+ * Visit the candid file and extract the fields.
+ * It returns the extracted service fields.
+ *
+ * @category Main
+ */
 export class VisitTransform<
   A extends ActorSubclass<any> = DefaultActorType,
   M extends FunctionName<A> = FunctionName<A>
diff --git a/packages/visitor/src/transform/table/index.ts b/packages/visitor/src/transform/table/index.ts
index 776e05dbf9..e7b73dae07 100644
--- a/packages/visitor/src/transform/table/index.ts
+++ b/packages/visitor/src/transform/table/index.ts
@@ -8,6 +8,12 @@ import type {
   Principal,
 } from "@ic-reactor/store"
 
+/**
+ * Visit the candid file and extract the fields.
+ * It returns the extracted service fields.
+ *
+ * @category Main
+ */
 export class VisitTransformTable<
   A extends ActorSubclass<any> = DefaultActorType,
   M extends FunctionName<A> = FunctionName<A>
diff --git a/packages/visitor/typedoc.json b/packages/visitor/typedoc.json
index a9bb6aa824..7fdf4ee81e 100644
--- a/packages/visitor/typedoc.json
+++ b/packages/visitor/typedoc.json
@@ -1,4 +1,5 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src"]
+  "entryPoints": ["./src"],
+  "name": "Visitor"
 }
diff --git a/typedoc.json b/typedoc.json
index eac6010380..d0f1966797 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -5,6 +5,7 @@
   "name": "ic-reactor",
   "customTitle": "ic-reactor",
   "navigationLinks": {
+    "Examples": "https://github.com/B3Pay/ic-reactor/tree/main/examples",
     "NPM": "https://www.npmjs.com/org/ic-reactor",
     "GitHub": "https://github.com/B3Pay/ic-reactor"
   },