Annotate modules, options and command major changes in 21.12

This commit is contained in:
Badlop 2021-12-02 16:43:17 +01:00
parent ca143c1873
commit d1bfd6c90d
4 changed files with 6 additions and 0 deletions

View File

@ -94,6 +94,7 @@ get_commands_spec() ->
result_example = ok},
#ejabberd_commands{name = gen_markdown_doc_for_tags, tags = [documentation],
desc = "Generates markdown documentation for ejabberd_commands",
note = "added in 21.12",
module = ejabberd_commands_doc, function = generate_tags_md,
args = [{file, binary}],
result = {res, rescode},

View File

@ -110,6 +110,7 @@ mod_doc() ->
#{desc =>
[?T("This module serves a simple page for the "
"https://conversejs.org/[Converse] XMPP web browser client."), "",
?T("This module is available since ejabberd 21.12."), "",
?T("To use this module, in addition to adding it to the 'modules' "
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
"http://../listen-options/#request-handlers[request_handlers]."), "",

View File

@ -4233,6 +4233,7 @@ delete_expired_items() ->
get_commands_spec() ->
[#ejabberd_commands{name = delete_old_pubsub_items, tags = [purge],
desc = "Keep only NUMBER of PubSub items per node",
note = "added in 21.12",
module = ?MODULE, function = delete_old_items,
args_desc = ["Number of items to keep per node"],
args = [{number, integer}],
@ -4242,6 +4243,7 @@ get_commands_spec() ->
result_example = ok},
#ejabberd_commands{name = delete_expired_pubsub_items, tags = [purge],
desc = "Delete expired PubSub items",
note = "added in 21.12",
module = ?MODULE, function = delete_expired_items,
args = [],
result = {res, rescode},
@ -4389,6 +4391,7 @@ mod_doc() ->
"is memory usage, as every item is stored in memory.")}},
{max_item_expire_node,
#{value => "timeout() | infinity",
note => "added in 21.12",
desc =>
?T("Specify the maximum item epiry time. Default value "
"is: 'infinity'.")}},

View File

@ -675,6 +675,7 @@ mod_doc() ->
"By default any user is able to unregister their account.")}},
{allow_modules,
#{value => "all | [Module, ...]",
note => "added in 21.12",
desc =>
?T("List of modules that can register accounts, or 'all'. "
"The default value is 'all', which is equivalent to "