Add 'required' and 'default' values for doc strings

1 files changed, 120 insertions, 30 deletions

diff --git a/src/plugins/surbl.c b/src/plugins/surbl.c
index 1c5e0625b..7572a0df8 100644
--- a/src/plugins/surbl.c
+++ b/src/plugins/surbl.c
@@ -292,52 +292,142 @@ surbl_module_init (struct rspamd_config *cfg, struct module_ctx **ctx)
 
 	*ctx = (struct module_ctx *)surbl_module_ctx;
 
-	rspamd_rcl_add_doc_by_path (cfg, NULL,
+	rspamd_rcl_add_doc_by_path (cfg,
+			NULL,
 			"URL blacklist plugin",
-			"surbl", UCL_OBJECT, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"surbl",
+			UCL_OBJECT,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"List of redirector servers",
-			"redirector", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"redirector",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Map of domains that should be checked with redirector",
-			"redirector_hosts_map", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"redirector_hosts_map",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Connect timeout for redirector",
-			"redirector_connect_timeout", UCL_TIME, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"redirector_connect_timeout",
+			UCL_TIME,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Read timeout for redirector",
-			"redirector_read_timeout", UCL_TIME, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"redirector_read_timeout",
+			UCL_TIME,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Maximum number of URLs to process per message",
-			"max_urls", UCL_INT, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"max_urls",
+			UCL_INT,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Rules for TLD composition",
-			"exceptions", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"exceptions",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"Map of whitelisted domains",
-			"whitelist", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl",
+			"whitelist",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl",
 			"URL blacklist rule",
-			"rule", UCL_OBJECT, NULL, 0);
+			"rule",
+			UCL_OBJECT,
+			NULL,
+			0,
+			NULL,
+			0);
 	/* Rules doc strings */
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Name of DNS black list (e.g. `multi.surbl.com`)",
-			"suffix", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+			"suffix",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Symbol to insert (if no bits or suffixes are defined)",
-			"symbol", UCL_STRING, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+			"symbol",
+			UCL_STRING,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Do not try to check URLs with IP address instead of hostname",
-			"no_ip", UCL_BOOLEAN, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+			"no_ip",
+			UCL_BOOLEAN,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Resolve URL host and then check against the specified suffix with reversed IP octets",
-			"resolve_ip", UCL_BOOLEAN, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+			"resolve_ip",
+			UCL_BOOLEAN,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Parse IP bits in DNS reply, the content is 'symbol = <bit>'",
-			"bits", UCL_OBJECT, NULL, 0);
-	rspamd_rcl_add_doc_by_path (cfg, "surbl.rule",
+			"bits",
+			UCL_OBJECT,
+			NULL,
+			0,
+			NULL,
+			0);
+	rspamd_rcl_add_doc_by_path (cfg,
+			"surbl.rule",
 			"Parse IP addresses in DNS reply, the content is 'symbol = address'",
-			"ips", UCL_OBJECT, NULL, 0);
+			"ips",
+			UCL_OBJECT,
+			NULL,
+			0,
+			NULL,
+			0);
 
 	return 0;
 }