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_register_web.erl | |
| parent | Update 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_register_web.erl')
| -rw-r--r-- | src/mod_register_web.erl | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/mod_register_web.erl b/src/mod_register_web.erl index 3ff172f13..967dc0769 100644 --- a/src/mod_register_web.erl +++ b/src/mod_register_web.erl @@ -56,6 +56,7 @@ -behaviour(gen_mod). -export([start/2, stop/1, reload/3, process/2, mod_options/1, depends/2]). +-export([mod_doc/0]). -include("logger.hrl"). @@ -628,3 +629,12 @@ get_error_text({error, wrong_parameters}) -> mod_options(_) -> []. + +mod_doc() -> + #{desc => + [?T("This module provides a web page where users can:"), "", + ?T("- Register a new account on the server."), "", + ?T("- Change the password from an existing account on the server."), "", + ?T("- Delete an existing account on the server."), "", + ?T("The module depends on 'mod_register' where all the configuration " + "is performed.")]}. |