Merge pull request #934 from status-im/doc

doc: add missing modules

CHANGELOG.md

@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **breaking**: `DecryptionParams` may be passed when using `queryHistory` instead of just keys.
 - Examples have been moved to https://github.com/waku-org/js-waku-examples.
 
+### Fixed
+
+- doc: add missing modules.
+
 ## [0.25.0] - 2022-09-5
 
 ### Changed

src/lib/peer_discovery_static_list.ts

@@ -23,15 +23,13 @@ export interface Options {
   /**
    * The interval between emitting addresses in milliseconds.
    *
-   * @default {@link PeerDiscoveryEvents.DefaultInterval}
+   * @default {@link PeerDiscoveryStaticPeers.DefaultInterval}
    */
   interval?: number;
 }
 
 /**
- * Parse options and expose function to return bootstrap peer addresses.
+ * Pass a list of multiaddr that will be used to bootstrap a node.
- *
- * @throws if an invalid combination of options is passed, see [[BootstrapOptions]] for details.
  */
 export class PeerDiscoveryStaticPeers
   extends EventEmitter<PeerDiscoveryEvents>

src/lib/predefined_bootstrap_nodes.ts

@@ -15,7 +15,7 @@ export enum Fleet {
  * Default behavior is to return nodes of the nwaku Status Prod fleet.
  *
  * @param fleet The fleet to be returned. Defaults to production fleet.
- * @param wantedNumber The number of connections desired. Defaults to [[DefaultWantedNumber]].
+ * @param wantedNumber The number of connections desired. Defaults to {@link DefaultWantedNumber}.
  *
  * @returns An array of multiaddresses.
  */

typedoc.json

@@ -1,7 +1,14 @@
 {
-  "entryPoints": ["./src/index.ts", "./src/lib/create_waku.ts"],
+  "entryPoints": [
+    "./src/index.ts",
+    "./src/lib/create_waku.ts",
+    "./src/lib/peer_discovery_dns.ts",
+    "./src/lib/peer_discovery_static_list.ts",
+    "./src/lib/predefined_bootstrap_nodes.ts",
+    "./src/lib/wait_for_remote_peer.ts"
+  ],
   "out": "build/docs",
-  "exclude": "**/*.spec.ts",
+  "exclude": ["**/*.spec.ts"],
   "excludeInternal": true,
   "validation": {
     "invalidLink": true,