From c9963a4aea7115905518c8f2a924f7c54f9a3ba1 Mon Sep 17 00:00:00 2001 From: "fryorcraken.eth" Date: Thu, 8 Sep 2022 18:44:16 +1000 Subject: [PATCH] docs: fix links --- src/lib/create_waku.ts | 9 +++++---- src/lib/wait_for_remote_peer.ts | 5 +++-- typedoc.json | 1 + 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/lib/create_waku.ts b/src/lib/create_waku.ts index cbe6d943f7..c11476c41b 100644 --- a/src/lib/create_waku.ts +++ b/src/lib/create_waku.ts @@ -53,8 +53,9 @@ export interface CreateOptions { /** * Create a Waku node that uses Waku Light Push, Filter and Store to send and * receive messages, enabling low resource consumption. - * **Note: This is NOT compatible with nwaku** - * Ref: https://github.com/status-im/nwaku/issues/1085 + * **Note: This is NOT compatible with nwaku v0.11** + * + * @see https://github.com/status-im/nwaku/issues/1085 */ export async function createLightNode( options?: CreateOptions & WakuOptions @@ -139,8 +140,8 @@ export async function createFullNode( } /** - * @deprecated use { @link createLightNode } (only compatible with nwaku v0.12), - * { @link createPrivacyNode } or { @link Waku.constructor } instead; + * @deprecated use { @link createLightNode }, { @link createPrivacyNode } or + * { @link index.waku.WakuNode.constructor } instead. */ export async function createWaku( options?: CreateOptions & WakuOptions diff --git a/src/lib/wait_for_remote_peer.ts b/src/lib/wait_for_remote_peer.ts index e68f2d7c86..ec6cec2437 100644 --- a/src/lib/wait_for_remote_peer.ts +++ b/src/lib/wait_for_remote_peer.ts @@ -23,8 +23,9 @@ interface WakuGossipSubProtocol extends GossipSub { /** * Wait for a remote peer to be ready given the passed protocols. - * Must be used after attempting to connect to nodes, using {@link index.waku.Waku.dial} or - * a bootstrap method with {@link index.waku.Waku.constructor}. + * Must be used after attempting to connect to nodes, using + * {@link index.waku.WakuNode.dial} or a bootstrap method with + * {@link lib/create_waku.createLightNode}. * * If the passed protocols is a GossipSub protocol, then it resolves only once * a peer is in a mesh, to help ensure that other peers will send and receive diff --git a/typedoc.json b/typedoc.json index 54badcf026..948a5a0b7e 100644 --- a/typedoc.json +++ b/typedoc.json @@ -2,6 +2,7 @@ "entryPoints": [ "./src/index.ts", "./src/lib/create_waku.ts", + "./src/lib/interfaces.ts", "./src/lib/peer_discovery_dns.ts", "./src/lib/peer_discovery_static_list.ts", "./src/lib/predefined_bootstrap_nodes.ts",