Browse Source

[Minor] Add lua_parsers to docs

tags/2.7
Vsevolod Stakhov 3 years ago
parent
commit
a323f7124e
2 changed files with 7 additions and 5 deletions
  1. 4
    2
      doc/Makefile
  2. 3
    3
      src/lua/lua_parsers.c

+ 4
- 2
doc/Makefile View File

@@ -21,7 +21,7 @@ lua-dirs:
lua-doc: lua-dirs rspamd_regexp rspamd_ip rspamd_config rspamd_task ucl rspamd_http rspamd_trie \
rspamd_resolver rspamd_redis rspamd_upstream_list rspamd_expression rspamd_mimepart rspamd_logger rspamd_url \
rspamd_tcp rspamd_mempool rspamd_html rspamd_util rspamd_sqlite3 rspamd_cryptobox rspamd_map \
lua_redis lua_util lua_maps lua_clickhouse lua_selectors rspamd_udp rspamd_text lua_mime
lua_redis lua_util lua_maps lua_clickhouse lua_selectors rspamd_udp rspamd_text lua_mime rspamd_parsers

lua_redis:
$(LLUADOC) < ../lualib/lua_redis.lua > markdown/lua/lua_redis.md
@@ -86,4 +86,6 @@ rspamd_map: ../src/lua/lua_map.c
rspamd_udp: ../src/lua/lua_udp.c
$(LUADOC) < ../src/lua/lua_udp.c > markdown/lua/rspamd_udp.md
rspamd_text: ../src/lua/lua_text.c
$(LUADOC) < ../src/lua/lua_text.c > markdown/lua/rspamd_text.md
$(LUADOC) < ../src/lua/lua_text.c > markdown/lua/rspamd_text.md
rspamd_parsers: ../src/lua/lua_parsers.c
$(LUADOC) < ../src/lua/lua_parsers.c > markdown/lua/rspamd_parsers.md

+ 3
- 3
src/lua/lua_parsers.c View File

@@ -25,12 +25,12 @@
#include "lua_parsers.h"

/***
* @module rspamd_util
* @module rspamd_parsers
* This module contains Lua-C interfaces to Rspamd parsers of different kind.
*/

/***
* @function util.tokenize_text(input[, exceptions])
* @function parsers.tokenize_text(input[, exceptions])
* Create tokens from a text using optional exceptions list
* @param {text/string} input input data
* @param {table} exceptions, a table of pairs containing <start_pos,length> of exceptions in the input
@@ -268,7 +268,7 @@ lua_parsers_parse_mail_address (lua_State *L)
}
else {
pool = rspamd_mempool_new (rspamd_mempool_suggest_size (),
"lua util", 0);
"lua parsers", 0);
own_pool = TRUE;
}


Loading…
Cancel
Save