diff --git a/src/lib/create_waku.ts b/src/lib/create_waku.ts index 9e3be207a8..3605273b56 100644 --- a/src/lib/create_waku.ts +++ b/src/lib/create_waku.ts @@ -16,7 +16,7 @@ import { WakuStore } from "./waku_store"; export interface CreateOptions { /** - * The PubSub Topic to use. Defaults to {@link DefaultPubSubTopic}. + * The PubSub Topic to use. * * One and only one pubsub topic is used by Waku. This is used by: * - WakuRelay to receive, route and send messages, @@ -26,15 +26,15 @@ export interface CreateOptions { * The usage of the default pubsub topic is recommended. * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/) for details. * - * @default {@link DefaultPubSubTopic} + * @default {@link index.DefaultPubSubTopic} */ pubSubTopic?: string; /** - * You can pass options to the `Libp2p` instance used by {@link Waku} using the {@link CreateOptions.libp2p} property. + * You can pass options to the `Libp2p` instance used by {@link index.waku.Waku} using the {@link CreateOptions.libp2p} property. * This property is the same type than the one passed to [`Libp2p.create`](https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create) * apart that we made the `modules` property optional and partial, * allowing its omission and letting Waku set good defaults. - * Notes that some values are overridden by {@link Waku} to ensure it implements the Waku protocol. + * Notes that some values are overridden by {@link index.waku.Waku} to ensure it implements the Waku protocol. */ libp2p?: Partial; /** diff --git a/src/lib/enr/enr.ts b/src/lib/enr/enr.ts index 47c88f5ce8..92d07eb2db 100644 --- a/src/lib/enr/enr.ts +++ b/src/lib/enr/enr.ts @@ -298,7 +298,7 @@ export class ENR extends Map { * address (e.g. `dns4`, `dnsaddr`, etc).. * * If the peer information only contains information that can be represented with the ENR pre-defined keys - * (ip, tcp, etc) then the usage of [[getLocationMultiaddr]] should be preferred. + * (ip, tcp, etc) then the usage of { @link getLocationMultiaddr } should be preferred. * * The multiaddresses stored in this field are expected to be location multiaddresses, ie, peer id less. */ @@ -318,7 +318,7 @@ export class ENR extends Map { * address (e.g. `dns4`, `dnsaddr`, etc).. * * If the peer information only contains information that can be represented with the ENR pre-defined keys - * (ip, tcp, etc) then the usage of [[setLocationMultiaddr]] should be preferred. + * (ip, tcp, etc) then the usage of { @link setLocationMultiaddr } should be preferred. * The multiaddresses stored in this field must be location multiaddresses, * ie, without a peer id. */ @@ -403,7 +403,7 @@ export class ENR extends Map { * Returns the full multiaddr from the ENR fields matching the provided * `protocol` parameter. * To return full multiaddrs from the `multiaddrs` ENR field, - * use [[ENR.getFullMultiaddrs]] + * use { @link ENR.getFullMultiaddrs }. * * @param protocol */ diff --git a/src/lib/enr/index.ts b/src/lib/enr/index.ts index 92a4208eee..32d56e1f6e 100644 --- a/src/lib/enr/index.ts +++ b/src/lib/enr/index.ts @@ -1,5 +1,3 @@ -import * as v4Crypto from "./v4"; -export const v4 = v4Crypto; export * from "./constants"; export * from "./enr"; export * from "./types"; diff --git a/src/lib/wait_for_remote_peer.ts b/src/lib/wait_for_remote_peer.ts index 24917fa608..85220e8dc1 100644 --- a/src/lib/wait_for_remote_peer.ts +++ b/src/lib/wait_for_remote_peer.ts @@ -22,8 +22,8 @@ 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 Waku.dial} or - * a bootstrap method with {@link Waku.constructor}. + * 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}. * * 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/src/lib/waku.ts b/src/lib/waku.ts index da40250eb6..33d18dde7d 100644 --- a/src/lib/waku.ts +++ b/src/lib/waku.ts @@ -170,7 +170,7 @@ export class Waku { /** * Register a decryption key to attempt decryption of messages received via - * [[WakuRelay]] and [[WakuStore]]. This can either be a private key for + * { @link WakuRelay } and { @link WakuStore }. This can either be a private key for * asymmetric encryption or a symmetric key. * * Strings must be in hex format. @@ -186,7 +186,7 @@ export class Waku { /** * Delete a decryption key that was used to attempt decryption of messages - * received via [[WakuRelay]] or [[WakuStore]]. + * received via { @link WakuRelay } or { @link WakuStore }. * * Strings must be in hex format. */ diff --git a/src/lib/waku_filter/index.ts b/src/lib/waku_filter/index.ts index d4b1281900..bef0827954 100644 --- a/src/lib/waku_filter/index.ts +++ b/src/lib/waku_filter/index.ts @@ -251,8 +251,8 @@ export class WakuFilter { /** * Register a decryption key to attempt decryption of messages received in any - * subsequent [[subscribe]] call. This can either be a private key for - * asymmetric encryption or a symmetric key. [[WakuStore]] will attempt to + * subsequent { @link subscribe } call. This can either be a private key for + * asymmetric encryption or a symmetric key. { @link WakuStore } will attempt to * decrypt messages using both methods. * * Strings must be in hex format. @@ -265,7 +265,7 @@ export class WakuFilter { } /** - * Delete a decryption key so that it cannot be used in future [[subscribe]] calls + * Delete a decryption key so that it cannot be used in future { @link subscribe } calls * * Strings must be in hex format. */ diff --git a/src/lib/waku_relay/index.ts b/src/lib/waku_relay/index.ts index 396e7db564..c104f0b3ab 100644 --- a/src/lib/waku_relay/index.ts +++ b/src/lib/waku_relay/index.ts @@ -37,8 +37,8 @@ export interface CreateOptions { } /** - * Implements the [Waku v2 Relay protocol]{@link https://rfc.vac.dev/spec/11/}. - * Must be passed as a `pubsub` module to a {Libp2p} instance. + * Implements the [Waku v2 Relay protocol](https://rfc.vac.dev/spec/11/). + * Must be passed as a `pubsub` module to a `Libp2p` instance. * * @implements {require('libp2p-interfaces/src/pubsub')} */ diff --git a/src/lib/waku_store/index.ts b/src/lib/waku_store/index.ts index 3b88e4f97b..c8f0d05ae5 100644 --- a/src/lib/waku_store/index.ts +++ b/src/lib/waku_store/index.ts @@ -52,19 +52,19 @@ export interface QueryOptions { pubSubTopic?: string; /** * The direction in which pages are retrieved: - * - [[PageDirection.BACKWARD]]: Most recent page first. - * - [[PageDirection.FORWARD]]: Oldest page first. + * - { @link PageDirection.BACKWARD }: Most recent page first. + * - { @link PageDirection.FORWARD }: Oldest page first. * * Note: This does not affect the ordering of messages with the page * (oldest message is always first). * - * @default [[PageDirection.BACKWARD]] + * @default { @link PageDirection.BACKWARD } */ pageDirection?: PageDirection; /** * The number of message per page. * - * @default [[DefaultPageSize]] + * @default { @link DefaultPageSize } */ pageSize?: number; /** @@ -274,8 +274,8 @@ export class WakuStore { /** * Register a decryption key to attempt decryption of messages received in any - * subsequent [[queryHistory]] call. This can either be a private key for - * asymmetric encryption or a symmetric key. [[WakuStore]] will attempt to + * subsequent { @link queryHistory } call. This can either be a private key for + * asymmetric encryption or a symmetric key. { @link WakuStore } will attempt to * decrypt messages using both methods. * * Strings must be in hex format. @@ -289,7 +289,7 @@ export class WakuStore { /**cursorV2Beta4 * Delete a decryption key that was used to attempt decryption of messages - * received in subsequent [[queryHistory]] calls. + * received in subsequent { @link queryHistory } calls. * * Strings must be in hex format. */