aboutsummaryrefslogtreecommitdiffstats
path: root/src/lua
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2015-04-09 17:22:43 +0100
committerVsevolod Stakhov <vsevolod@highsecure.ru>2015-04-09 17:22:43 +0100
commitcf28be3242d57d08bd3666bbce4f60ed67de3022 (patch)
tree0a9fa4c2e697811bd606157dce557d027067bffc /src/lua
parent3c73848f7989b6b0e5d9495affea454462ece482 (diff)
downloadrspamd-cf28be3242d57d08bd3666bbce4f60ed67de3022.tar.gz
rspamd-cf28be3242d57d08bd3666bbce4f60ed67de3022.zip
Forgot @module.
Diffstat (limited to 'src/lua')
-rw-r--r--src/lua/lua_dns.c1
-rw-r--r--src/lua/lua_expression.c6
-rw-r--r--src/lua/lua_http.c1
-rw-r--r--src/lua/lua_ip.c2
-rw-r--r--src/lua/lua_redis.c1
-rw-r--r--src/lua/lua_trie.c1
-rw-r--r--src/lua/lua_upstream.c1
7 files changed, 12 insertions, 1 deletions
diff --git a/src/lua/lua_dns.c b/src/lua/lua_dns.c
index 950f57117..0133b528b 100644
--- 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 2d7ceb734..d8bd0409e 100644
--- a/src/lua/lua_expression.c
+++ b/src/lua/lua_expression.c
@@ -26,6 +26,12 @@
#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
* @param {string} line expression line
diff --git a/src/lua/lua_http.c b/src/lua/lua_http.c
index 3858d06c9..7e48b7fd6 100644
--- 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 452e45f14..43f9892d9 100644
--- 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 01b4493bd..3a1a8e89a 100644
--- 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 540724836..9c0781c5e 100644
--- 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 4d051ba10..31ced8103 100644
--- 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:
*