From c3b01751ce7e4790bdec5b84f674df0148bf8d82 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 9 Feb 2023 14:45:32 +1100 Subject: [PATCH] chore: fix doc generation --- package.json | 2 +- packages/core/src/lib/waku.ts | 6 +++--- typedoc.cjs | 3 ++- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index c68c12eb22..854d1a3207 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "proto": "npm run proto --workspaces --if-present", "deploy": "node ci/deploy.js", "doc": "run-s doc:*", - "doc:html": "typedoc --options typedoc.cjs --treatWarningsAsErrors", + "doc:html": "typedoc --options typedoc.cjs", "doc:cname": "echo 'js.waku.org' > docs/CNAME" }, "devDependencies": { diff --git a/packages/core/src/lib/waku.ts b/packages/core/src/lib/waku.ts index e584dc7f6b..ec8aa23da1 100644 --- a/packages/core/src/lib/waku.ts +++ b/packages/core/src/lib/waku.ts @@ -30,19 +30,19 @@ export interface WakuOptions { * Set keep alive frequency in seconds: Waku will send a `/ipfs/ping/1.0.0` * request to each peer after the set number of seconds. Set to 0 to disable. * - * @default {@link DefaultPingKeepAliveValueSecs} + * @default {@link @waku/core.DefaultPingKeepAliveValueSecs} */ pingKeepAlive?: number; /** * Set keep alive frequency in seconds: Waku will send a ping message over * relay to each peer after the set number of seconds. Set to 0 to disable. * - * @default {@link DefaultRelayKeepAliveValueSecs} + * @default {@link @waku/core.DefaultRelayKeepAliveValueSecs} */ relayKeepAlive?: number; /** * Set the user agent string to be used in identification of the node. - * @default {@link DefaultUserAgent} + * @default {@link @waku/core.DefaultUserAgent} */ userAgent?: string; } diff --git a/typedoc.cjs b/typedoc.cjs index 2b84c018f0..c278a6a34d 100644 --- a/typedoc.cjs +++ b/typedoc.cjs @@ -8,9 +8,10 @@ module.exports = { out: "docs", exclude: ["**/*.spec.ts"], excludeInternal: true, + treatWarningsAsErrors: true, + excludeExternals: true, validation: { invalidLink: true, notExported: true, }, }; -packageJson.workspaces;