aboutsummaryrefslogtreecommitdiff
path: root/src/mod_blocking.erl
diff options
context:
space:
mode:
authorEvgeny Khramtsov <ekhramtsov@process-one.net>2020-01-08 12:24:51 +0300
committerEvgeny Khramtsov <ekhramtsov@process-one.net>2020-01-08 12:24:51 +0300
commit97da380acd8e3ba0c9a9618a99c4106eca1d1576 (patch)
treecc2b8fb7e175afcaf182a3595735f6f9177ec3dc /src/mod_blocking.erl
parentUpdate deps (diff)
Generate ejabberd.yml.5 man page from source code directly
Several documentation callbacks (doc/0 and mod_doc/0) are implemented and `ejabberdctl man` command is added to generate a man page. Note that the command requires a2x to be installed (which is a part of asciidoc package).
Diffstat (limited to 'src/mod_blocking.erl')
-rw-r--r--src/mod_blocking.erl10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/mod_blocking.erl b/src/mod_blocking.erl
index 3ddb10a6d..9b9f94dec 100644
--- a/src/mod_blocking.erl
+++ b/src/mod_blocking.erl
@@ -30,7 +30,7 @@
-protocol({xep, 191, '1.2'}).
-export([start/2, stop/1, reload/3, process_iq/1, depends/2,
- disco_features/5, mod_options/1]).
+ disco_features/5, mod_options/1, mod_doc/0]).
-include("logger.hrl").
-include("xmpp.hrl").
@@ -265,3 +265,11 @@ err_db_failure(#iq{lang = Lang} = IQ) ->
mod_options(_Host) ->
[].
+
+mod_doc() ->
+ #{desc =>
+ [?T("The module implements "
+ "https://xmpp.org/extensions/xep-0191.html"
+ "[XEP-0191: Blocking Command]."), "",
+ ?T("This module depends on 'mod_privacy' where "
+ "all the configuration is performed.")]}.