diff options
| author | Evgeny Khramtsov <ekhramtsov@process-one.net> | 2020-01-08 12:24:51 +0300 |
|---|---|---|
| committer | Evgeny Khramtsov <ekhramtsov@process-one.net> | 2020-01-08 12:24:51 +0300 |
| commit | 97da380acd8e3ba0c9a9618a99c4106eca1d1576 (patch) | |
| tree | cc2b8fb7e175afcaf182a3595735f6f9177ec3dc /src/mod_sic.erl | |
| parent | c40d8fe11b4842795fdeab408b0a61e208071d21 (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_sic.erl')
| -rw-r--r-- | src/mod_sic.erl | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/mod_sic.erl b/src/mod_sic.erl index f8105f2cd..037e514c2 100644 --- a/src/mod_sic.erl +++ b/src/mod_sic.erl @@ -32,7 +32,7 @@ -behaviour(gen_mod). -export([start/2, stop/1, reload/3, process_local_iq/1, - process_sm_iq/1, mod_options/1, depends/2]). + process_sm_iq/1, mod_options/1, depends/2, mod_doc/0]). -include("logger.hrl"). -include("xmpp.hrl"). @@ -96,3 +96,14 @@ get_ip({User, Server, Resource}, mod_options(_Host) -> []. + +mod_doc() -> + #{desc => + [?T("This module adds support for " + "https://xmpp.org/extensions/xep-0279.html" + "[XEP-0279: Server IP Check]. This protocol enables " + "a client to discover its external IP address."), "", + ?T("WARNING: The protocol extension is deferred and seems " + "like there are no clients supporting it, so using this " + "module is not recommended and, furthermore, the module " + "might be removed in the future.")]}. |