From ad4e91c8fcc7304a0c0f18474056314e2bb86d37 Mon Sep 17 00:00:00 2001
From: Peter Vlugter <pvlugter@users.noreply.github.com>
Date: Mon, 23 May 2022 18:58:53 +1200
Subject: [PATCH] chore: tweak typedoc settings (#335)

---
 sdk/src/event-sourced-entity.ts | 12 ++++++------
 sdk/src/value-entity.ts         |  2 +-
 sdk/typedoc.json                | 12 +++++++++---
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/sdk/src/event-sourced-entity.ts b/sdk/src/event-sourced-entity.ts
index b3809205..f752db98 100644
--- a/sdk/src/event-sourced-entity.ts
+++ b/sdk/src/event-sourced-entity.ts
@@ -131,8 +131,8 @@ export namespace EventSourcedEntity {
    *
    * @typeParam State - the type of {@link Serializable} state
    * @typeParam Events - the type of all {@link Serializable} events
-   * @typeParam CommandHandlers - optional type of {@link EventSourcedEntity.CommandHandlers}
-   * @typeParam EventHandlers - optional type of {@link EventSourcedEntity.EventHandlers}
+   * @typeParam CommandHandlers - optional type of {@link CommandHandlers}
+   * @typeParam EventHandlers - optional type of {@link EventHandlers}
    */
   export type Behavior<
     State extends Serializable = any,
@@ -170,8 +170,8 @@ export namespace EventSourcedEntity {
    *
    * @typeParam State - the type of {@link Serializable} state
    * @typeParam Events - the type of all {@link Serializable} events
-   * @typeParam CommandHandlers - optional type of {@link EventSourcedEntity.CommandHandlers}
-   * @typeParam EventHandlers - optional type of {@link EventSourcedEntity.EventHandlers}
+   * @typeParam CommandHandlers - optional type of {@link CommandHandlers}
+   * @typeParam EventHandlers - optional type of {@link EventHandlers}
    * @param state - The entity state
    * @returns The new entity state
    */
@@ -251,8 +251,8 @@ const defaultOptions = {
  *
  * @typeParam State - the type of {@link Serializable} state
  * @typeParam Events - the type of all {@link Serializable} events
- * @typeParam CommandHandlers - optional type of {@link EventSourcedEntity.CommandHandlers}
- * @typeParam EventHandlers - optional type of {@link EventSourcedEntity.EventHandlers}
+ * @typeParam CommandHandlers - optional type of CommandHandlers
+ * @typeParam EventHandlers - optional type of EventHandlers
  *
  * @public
  */
diff --git a/sdk/src/value-entity.ts b/sdk/src/value-entity.ts
index c44486e6..e9c83112 100644
--- a/sdk/src/value-entity.ts
+++ b/sdk/src/value-entity.ts
@@ -137,7 +137,7 @@ const defaultOptions = {
  * Value Entity.
  *
  * @typeParam State - the type of {@link Serializable} state
- * @typeParam CommandHandlers - optional type of {@link ValueEntity.CommandHandlers}
+ * @typeParam CommandHandlers - optional type of CommandHandlers
  *
  * @public
  */
diff --git a/sdk/typedoc.json b/sdk/typedoc.json
index f86842eb..a2c4eeb9 100644
--- a/sdk/typedoc.json
+++ b/sdk/typedoc.json
@@ -1,9 +1,15 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": [
-    "./index.ts"
-  ],
+  "entryPoints": ["./index.ts"],
   "excludeInternal": true,
   "excludePrivate": true,
+  "readme": "none",
+  "sort": ["source-order"],
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "notDocumented": false
+  },
+  "treatWarningsAsErrors": true,
   "out": "apidocs"
 }