Minor fixes in doc

This commit is contained in:
Badlop 2020-04-09 12:01:05 +02:00
parent 2febd1c220
commit 8694517c34
3 changed files with 12 additions and 9 deletions

View File

@ -36,14 +36,14 @@ doc() ->
{listen, {listen,
#{value => "[Options, ...]", #{value => "[Options, ...]",
desc => desc =>
?T("The option for listeners configuration. See " ?T("The option for listeners configuration. See the "
"<<listeners,Listeners>> section of this document " "http://../listen/[Listen Modules] section "
"for details.")}}, "for details.")}},
{modules, {modules,
#{value => "{Module: Options}", #{value => "{Module: Options}",
desc => desc =>
?T("The option for modules configuration. See " ?T("The option for modules configuration. See "
"<<modules,Modules>> section of this document " "http://../modules/[Modules] section "
"for details.")}}, "for details.")}},
{loglevel, {loglevel,
#{value => #{value =>
@ -355,11 +355,12 @@ doc() ->
"at least one of the methods succeeds. " "at least one of the methods succeeds. "
"The default value is '[mnesia]'.")}}, "The default value is '[mnesia]'.")}},
{auth_opts, {auth_opts,
#{desc => #{value => "[Option, ...]",
?T("This option is used by the contributed module " desc =>
?T("This is used by the contributed module "
"'ejabberd_auth_http' that can be installed from the " "'ejabberd_auth_http' that can be installed from the "
"'ejabberd-contrib' Git repository. Please refer to that " "'ejabberd-contrib' Git repository. Please refer to that "
"module's README file for details about this option.")}}, "module's README file for details.")}},
{auth_password_format, {auth_password_format,
#{value => "plain | scram", #{value => "plain | scram",
desc => desc =>
@ -445,7 +446,8 @@ doc() ->
"any given JID. The option is intended to protect the server " "any given JID. The option is intended to protect the server "
"from CAPTCHA DoS. The default value is 'infinity'.")}}, "from CAPTCHA DoS. The default value is 'infinity'.")}},
{captcha_host, {captcha_host,
#{desc => ?T("Deprecated. Use 'captcha_url' instead.")}}, #{value => "String",
desc => ?T("Deprecated. Use 'captcha_url' instead.")}},
{captcha_url, {captcha_url,
#{value => ?T("URL"), #{value => ?T("URL"),
desc => desc =>

View File

@ -267,7 +267,8 @@ listen_options() ->
mod_doc() -> mod_doc() ->
#{desc => #{desc =>
?T("This module adds support for the MQTT protocol " ?T("This module adds support for the MQTT protocol "
"version '3.1.1' and '5.0'."), "version '3.1.1' and '5.0'. Remember to configure "
"'mod_mqtt' in 'modules' and 'listen' sections."),
opts => opts =>
[{access_subscribe, [{access_subscribe,
#{value => "{TopicFilter: AccessName}", #{value => "{TopicFilter: AccessName}",

View File

@ -627,7 +627,7 @@ mod_doc() ->
?T("- Delete an existing account on the server."), "", ?T("- Delete an existing account on the server."), "",
?T("This module supports CAPTCHA image to register a new account. " ?T("This module supports CAPTCHA image to register a new account. "
"To enable this feature, configure the options 'captcha\_cmd' " "To enable this feature, configure the options 'captcha\_cmd' "
"and 'captcha\_host', which are documented in the section with " "and 'captcha\_url', which are documented in the section with "
"top-level options."), "", "top-level options."), "",
?T("As an example usage, the users of the host 'example.org' can " ?T("As an example usage, the users of the host 'example.org' can "
"visit the page: 'https://example.org:5281/register/' It is " "visit the page: 'https://example.org:5281/register/' It is "