chore: tweak typedoc settings (#335)

lightbend · May 23, 2022 · ad4e91c · ad4e91c
1 parent 5abe4e1
commit ad4e91c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git 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
@@ -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
@@ -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"
 }