Explorar el Código

[Minor] Updates for API documentation

 - Put nested lists on the correct level
 - Document more symbol type options
 - Try be clearer about dependencies
tags/3.1
Andrew Lewis hace 2 años
padre
commit
4b9d98c086
Se han modificado 1 ficheros con 26 adiciones y 18 borrados
  1. 26
    18
      src/lua/lua_config.c

+ 26
- 18
src/lua/lua_config.c Ver fichero

@@ -201,15 +201,22 @@ LUA_FUNCTION_DEF (config, get_classifier);
* - `callback`: function to be called for symbol's check (can be absent for virtual symbols)
* - `weight`: weight of symbol (should normally be 1 or missing)
* - `priority`: priority of symbol (normally 0 or missing)
* - `type`: type of symbol: `normal` (default), `virtual` or `callback`
* - `type`: type of symbol:
* + `normal`: executed after prefilters, according to dependency graph or in undefined order
* + `callback`: a check that merely inserts virtual symbols
* + `connfilter`: executed early; before message body is available
* + `idempotent`: cannot change result in any way; executed last
* + `postfilter`: executed after most other checks
* + `prefilter`: executed before most other checks
* + `virtual`: a symbol inserted by its parent check
* - `flags`: various flags split by commas or spaces:
* + `nice` if symbol can produce negative score;
* + `empty` if symbol can be called for empty messages
* + `skip` if symbol should be skipped now
* + `nostat` if symbol should be excluded from stat tokens
* + `trivial` symbol is trivial (e.g. no network requests)
* + `explicit_disable` requires explicit disabling (e.g. via settings)
* + `ignore_passthrough` executed even if passthrough result has been set
* + `nice` if symbol can produce negative score;
* + `empty` if symbol can be called for empty messages
* + `skip` if symbol should be skipped now
* + `nostat` if symbol should be excluded from stat tokens
* + `trivial` symbol is trivial (e.g. no network requests)
* + `explicit_disable` requires explicit disabling (e.g. via settings)
* + `ignore_passthrough` executed even if passthrough result has been set
* - `parent`: id of parent symbol (useful for virtual symbols)
*
* @return {number} id of symbol registered
@@ -247,11 +254,11 @@ LUA_FUNCTION_DEF (config, register_callback_symbol);
LUA_FUNCTION_DEF (config, register_callback_symbol_priority);

/***
* @method rspamd_config:register_dependency(id, dep)
* Create a dependency between symbol identified by `id` and a symbol identified
* by some symbolic name `dep`
* @method rspamd_config:register_dependency(id|name, depname)
* Create a dependency on symbol identified by name for symbol identified by ID or name.
* This affects order of checks only (a symbol is still checked if its dependencys are disabled).
* @param {number|string} id id or name of source (numeric id is returned by all register_*_symbol)
* @param {string} dep dependency name
* @param {string} depname dependency name
* @example
local function cb(task)
...
@@ -260,7 +267,8 @@ end
local id = rspamd_config:register_symbol('SYM', 1.0, cb)
rspamd_config:register_dependency(id, 'OTHER_SYM')
-- Alternative form
rspamd_config:register_dependency('SYMBOL_FROM', 'SYMBOL_TO')
-- Symbol MY_RULE needs result from SPF_CHECK
rspamd_config:register_dependency('MY_RULE', 'SPF_CHECK')
*/
LUA_FUNCTION_DEF (config, register_dependency);

@@ -305,9 +313,9 @@ LUA_FUNCTION_DEF (config, register_re_selector);
* - `one_shot`: turn off multiple hits for a symbol (boolean, optional)
* - `one_param`: turn off multiple options for a symbol (boolean, optional)
* - `flags`: comma separated string of flags:
* + `ignore`: do not strictly check validity of symbol and corresponding rule
* + `one_shot`: turn off multiple hits for a symbol
* + `one_param`: allow only one parameter for a symbol
* + `ignore`: do not strictly check validity of symbol and corresponding rule
* + `one_shot`: turn off multiple hits for a symbol
* + `one_param`: allow only one parameter for a symbol
* - `priority`: priority of symbol's definition
*/
LUA_FUNCTION_DEF (config, set_metric_symbol);
@@ -332,8 +340,8 @@ LUA_FUNCTION_DEF (config, set_metric_action);
* - `group`: name of group for symbol (string, optional)
* - `one_shot`: turn off multiple hits for a symbol (boolean, optional)
* - `flags`: comma separated string of flags:
* + `ignore`: do not strictly check validity of symbol and corresponding rule
* + `one_shot`: turn off multiple hits for a symbol
* + `ignore`: do not strictly check validity of symbol and corresponding rule
* + `one_shot`: turn off multiple hits for a symbol
*
* @param {string} name name of symbol
* @return {table} symbol's definition or nil in case of undefined symbol

Cargando…
Cancelar
Guardar