From d1bfd6c90d7e7d1bc033358e5b7e0570f03df084 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 2 Dec 2021 16:43:17 +0100 Subject: [PATCH] Annotate modules, options and command major changes in 21.12 --- src/ejabberd_commands.erl | 1 + src/mod_conversejs.erl | 1 + src/mod_pubsub.erl | 3 +++ src/mod_register.erl | 1 + 4 files changed, 6 insertions(+) diff --git a/src/ejabberd_commands.erl b/src/ejabberd_commands.erl index c00b1469a..ddf0d3c59 100644 --- a/src/ejabberd_commands.erl +++ b/src/ejabberd_commands.erl @@ -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}, diff --git a/src/mod_conversejs.erl b/src/mod_conversejs.erl index 0b5d57a15..8683d60ab 100644 --- a/src/mod_conversejs.erl +++ b/src/mod_conversejs.erl @@ -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]."), "", diff --git a/src/mod_pubsub.erl b/src/mod_pubsub.erl index 43344986e..76092f1c6 100644 --- a/src/mod_pubsub.erl +++ b/src/mod_pubsub.erl @@ -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'.")}}, diff --git a/src/mod_register.erl b/src/mod_register.erl index 0bb0978ef..b85efd57c 100644 --- a/src/mod_register.erl +++ b/src/mod_register.erl @@ -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 "