diff options
Diffstat (limited to 'src/gen_mod.erl')
| -rw-r--r-- | src/gen_mod.erl | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/gen_mod.erl b/src/gen_mod.erl index 58ec9950f..d424f4b5c 100644 --- a/src/gen_mod.erl +++ b/src/gen_mod.erl @@ -5,7 +5,7 @@ %%% Created : 24 Jan 2003 by Alexey Shchepin <alexey@process-one.net> %%% %%% -%%% ejabberd, Copyright (C) 2002-2019 ProcessOne +%%% ejabberd, Copyright (C) 2002-2020 ProcessOne %%% %%% This program is free software; you can redistribute it and/or %%% modify it under the terms of the GNU General Public License as @@ -53,12 +53,18 @@ -type opts() :: #{atom() => term()}. -type db_type() :: atom(). +-type opt_desc() :: #{desc => binary() | [binary()], + value => string() | binary()}. +-type opt_doc() :: {atom(), opt_desc()} | {atom(), opt_desc(), [opt_doc()]}. -callback start(binary(), opts()) -> ok | {ok, pid()} | {error, term()}. -callback stop(binary()) -> any(). -callback reload(binary(), opts(), opts()) -> ok | {ok, pid()} | {error, term()}. -callback mod_opt_type(atom()) -> econf:validator(). -callback mod_options(binary()) -> [{atom(), term()} | atom()]. +-callback mod_doc() -> #{desc => binary() | [binary()], + opts => [opt_doc()], + example => [string()] | [{binary(), [string()]}]}. -callback depends(binary(), opts()) -> [{module(), hard | soft}]. -optional_callbacks([mod_opt_type/1, reload/3]). |