From 4f094b4ed786b81f0480f4df4fec8c80c6139ab2 Mon Sep 17 00:00:00 2001
From: Daniel Sanchez Quiros <sanchez.quiros.daniel@gmail.com>
Date: Thu, 29 Sep 2022 18:55:45 +0200
Subject: [PATCH] Added config docs

---
 waku/src/node_management/config.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/waku/src/node_management/config.rs b/waku/src/node_management/config.rs
index b1d5c61..ec928ff 100644
--- a/waku/src/node_management/config.rs
+++ b/waku/src/node_management/config.rs
@@ -5,17 +5,28 @@ use multiaddr::Multiaddr;
 use serde::{Deserialize, Serialize};
 // internal
 
+/// Waku node configuration
 #[derive(Clone, Default, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct NodeConfig {
+    /// Listening IP address. Default `0.0.0.0`
     host: Option<std::net::IpAddr>,
+    /// Libp2p TCP listening port. Default `60000`. Use `0` for **random**
     port: Option<usize>,
+    /// External address to advertise to other nodes. Can be ip4, ip6 or dns4, dns6.
+    /// If null, the multiaddress(es) generated from the ip and port specified in the config (or default ones) will be used.
+    /// Default: null
     advertise_addr: Option<Multiaddr>,
+    /// Secp256k1 private key in Hex format (`0x123...abc`). Default random
     #[serde(with = "secret_key_serde")]
     node_key: Option<SecretKey>,
+    /// Interval in seconds for pinging peers to keep the connection alive. Default `20`
     keep_alive_interval: Option<usize>,
+    /// Enable relay protocol. Default `true`
     relay: Option<bool>,
+    /// The minimum number of peers required on a topic to allow broadcasting a message. Default `0`
     min_peers_to_publish: Option<usize>,
+    /// Enable filter protocol. Default `false`
     filter: Option<bool>,
 }