Forgot @module.

diff --git a/src/lua/lua_dns.c b/src/lua/lua_dns.c
index 950f57117bc7e78425e648edc20d9248ac571fcf..0133b528bdcb4318aa2cd1baae0748df2e0264a9 100644 (file)
--- a/src/lua/lua_dns.c
+++ b/src/lua/lua_dns.c
@@ -27,6 +27,7 @@
 
 
 /***
+ * @module rspamd_resolver
  * This module allows to resolve DNS names from LUA code. All resolving is executed
  * asynchronously. Here is an example of name resolution:
  * @example

diff --git a/src/lua/lua_expression.c b/src/lua/lua_expression.c
index 2d7ceb73456edc4d67d2ebf45916aff6196fd0c8..d8bd0409e7db49669668a240e509ce94a4047954 100644 (file)
--- a/src/lua/lua_expression.c
+++ b/src/lua/lua_expression.c
@@ -25,6 +25,12 @@
 #include "lua_common.h"
 #include "expression.h"
 
+/***
+ * @module rspamd_expression
+ * This module can be used to implement different logic expressions in lua using
+ * rspamd AST optimizer. There are some examples in individual methods definitions to help understanding of this module.
+ */
+
 /***
  * @function rspamd_expression.create(line, {parse_func, process_func}, pool)
  * Create expression from the line using atom parsing routines and the specified memory pool

diff --git a/src/lua/lua_http.c b/src/lua/lua_http.c
index 3858d06c98c543e914eb66c49afae0c1d001a35c..7e48b7fd634d478f843955da6068c94bf4988a1d 100644 (file)
--- a/src/lua/lua_http.c
+++ b/src/lua/lua_http.c
@@ -28,6 +28,7 @@
 #include "utlist.h"
 
 /***
+ * @module rspamd_http
  * Rspamd HTTP module represents HTTP asynchronous client available from LUA code.
  * This module hides all complexity: DNS resolving, sessions management, zero-copy
  * text transfers and so on under the hood.

diff --git a/src/lua/lua_ip.c b/src/lua/lua_ip.c
index 452e45f148f9558487b8488179fcf895f5154261..43f9892d9a015a5dbfe3053f8eca29387ee50133 100644 (file)
--- a/src/lua/lua_ip.c
+++ b/src/lua/lua_ip.c
@@ -24,8 +24,8 @@
 #include "lua_common.h"
 
 /***
- * `rspamd_ip` is a helper module to simplify IP addresses manipulations.
  * @module rspamd_ip
+ * `rspamd_ip` is a helper module to simplify IP addresses manipulations.
  * @example
 local print_octets = function(ip)
         print('Normal order octets:')

diff --git a/src/lua/lua_redis.c b/src/lua/lua_redis.c
index 01b4493bd4371c0bab3967a96d5a2ce913c1bf2d..3a1a8e89a0a4caa748a16f194ebac0f8e13669b1 100644 (file)
--- a/src/lua/lua_redis.c
+++ b/src/lua/lua_redis.c
@@ -31,6 +31,7 @@
 #define REDIS_DEFAULT_TIMEOUT 1.0
 
 /***
+ * @module rspamd_redis
  * This module implements redis asynchronous client for rspamd LUA API.
  * Here is an example of using of this module:
  * @example

diff --git a/src/lua/lua_trie.c b/src/lua/lua_trie.c
index 540724836d36c62bdb575c4bbd1df5de2f693a13..9c0781c5e6bd72dab7da3f54bc024d424a1cc694 100644 (file)
--- a/src/lua/lua_trie.c
+++ b/src/lua/lua_trie.c
@@ -28,6 +28,7 @@
 #include "message.h"
 
 /***
+ * @module rspamd_trie
  * Rspamd trie module provides the data structure suitable for searching of many
  * patterns in arbitrary texts (or binary chunks). The algorithmic complexity of
  * this algorithm is at most O(n + m + z), where `n` is the length of text, `m` is a length of pattern and `z` is a number of patterns in the text.

diff --git a/src/lua/lua_upstream.c b/src/lua/lua_upstream.c
index 4d051ba100fb25bcd7f1a4767f0fedb3fa91c070..31ced81031e48b2e4b88e0dffdaa1d79f8d5fa1a 100644 (file)
--- a/src/lua/lua_upstream.c
+++ b/src/lua/lua_upstream.c
@@ -28,6 +28,7 @@
 
 
 /***
+ * @module rspamd_upstream_list
  * This module implements upstreams manipulation from LUA API. This functionality
  * can be used for load balancing using different strategies including:
  *