mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-22 16:20:52 +01:00
Fix example value for rescode return type
This commit is contained in:
parent
d5b3e6af00
commit
217b6da5fd
@ -104,7 +104,7 @@ get_commands_spec() ->
|
|||||||
args_example = ["/home/me/srcs/ejabberd/mod_example.erl"],
|
args_example = ["/home/me/srcs/ejabberd/mod_example.erl"],
|
||||||
args_desc = ["Filename of erlang source file to compile"],
|
args_desc = ["Filename of erlang source file to compile"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = get_cookie, tags = [erlang],
|
#ejabberd_commands{name = get_cookie, tags = [erlang],
|
||||||
desc = "Get the Erlang cookie of this node",
|
desc = "Get the Erlang cookie of this node",
|
||||||
@ -120,7 +120,7 @@ get_commands_spec() ->
|
|||||||
args_example = ["ejabberd@server2"],
|
args_example = ["ejabberd@server2"],
|
||||||
args_desc = ["Name of erlang node to remove"],
|
args_desc = ["Name of erlang node to remove"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = num_active_users, tags = [accounts, stats],
|
#ejabberd_commands{name = num_active_users, tags = [accounts, stats],
|
||||||
desc = "Get number of users active in the last days",
|
desc = "Get number of users active in the last days",
|
||||||
@ -158,7 +158,7 @@ get_commands_spec() ->
|
|||||||
args_example = [<<"peter">>, <<"myserver.com">>],
|
args_example = [<<"peter">>, <<"myserver.com">>],
|
||||||
args_desc = ["User name to check", "Server to check"],
|
args_desc = ["User name to check", "Server to check"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = check_password, tags = [accounts],
|
#ejabberd_commands{name = check_password, tags = [accounts],
|
||||||
desc = "Check if a password is correct",
|
desc = "Check if a password is correct",
|
||||||
@ -167,7 +167,7 @@ get_commands_spec() ->
|
|||||||
args_example = [<<"peter">>, <<"myserver.com">>, <<"secret">>],
|
args_example = [<<"peter">>, <<"myserver.com">>, <<"secret">>],
|
||||||
args_desc = ["User name to check", "Server to check", "Password to check"],
|
args_desc = ["User name to check", "Server to check", "Password to check"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = check_password_hash, tags = [accounts],
|
#ejabberd_commands{name = check_password_hash, tags = [accounts],
|
||||||
desc = "Check if the password hash is correct",
|
desc = "Check if the password hash is correct",
|
||||||
@ -180,7 +180,7 @@ get_commands_spec() ->
|
|||||||
args_desc = ["User name to check", "Server to check",
|
args_desc = ["User name to check", "Server to check",
|
||||||
"Password's hash value", "Name of hash method"],
|
"Password's hash value", "Name of hash method"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = change_password, tags = [accounts],
|
#ejabberd_commands{name = change_password, tags = [accounts],
|
||||||
desc = "Change the password of an account",
|
desc = "Change the password of an account",
|
||||||
@ -190,7 +190,7 @@ get_commands_spec() ->
|
|||||||
args_desc = ["User name", "Server name",
|
args_desc = ["User name", "Server name",
|
||||||
"New password for user"],
|
"New password for user"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = ban_account, tags = [accounts],
|
#ejabberd_commands{name = ban_account, tags = [accounts],
|
||||||
desc = "Ban an account: kick sessions and set random password",
|
desc = "Ban an account: kick sessions and set random password",
|
||||||
@ -200,7 +200,7 @@ get_commands_spec() ->
|
|||||||
args_desc = ["User name to ban", "Server name",
|
args_desc = ["User name to ban", "Server name",
|
||||||
"Reason for banning user"],
|
"Reason for banning user"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = num_resources, tags = [session],
|
#ejabberd_commands{name = num_resources, tags = [session],
|
||||||
desc = "Get the number of resources of a user",
|
desc = "Get the number of resources of a user",
|
||||||
@ -229,7 +229,7 @@ get_commands_spec() ->
|
|||||||
args_desc = ["User name", "Server name", "User's resource",
|
args_desc = ["User name", "Server name", "User's resource",
|
||||||
"Reason for closing session"],
|
"Reason for closing session"],
|
||||||
result = {res, rescode},
|
result = {res, rescode},
|
||||||
result_example = 0,
|
result_example = ok,
|
||||||
result_desc = "Status code: 0 on success, 1 otherwise"},
|
result_desc = "Status code: 0 on success, 1 otherwise"},
|
||||||
#ejabberd_commands{name = status_num_host, tags = [session, stats],
|
#ejabberd_commands{name = status_num_host, tags = [session, stats],
|
||||||
desc = "Number of logged users with this status in host",
|
desc = "Number of logged users with this status in host",
|
||||||
|
Loading…
Reference in New Issue
Block a user