Fix example value for rescode return type

diff --git a/src/mod_admin_extra.erl b/src/mod_admin_extra.erl
index edfe7a5efc1dd8dd6495dd065ac20c42810e1f69..bd5a8489c9a9d563c72cce45830830f5b7fe1379 100644 (file)
--- a/src/mod_admin_extra.erl
+++ b/src/mod_admin_extra.erl
@@ -104,7 +104,7 @@ get_commands_spec() ->
                        args_example = ["/home/me/srcs/ejabberd/mod_example.erl"],
                        args_desc = ["Filename of erlang source file to compile"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = get_cookie, tags = [erlang],
                        desc = "Get the Erlang cookie of this node",
@@ -120,7 +120,7 @@ get_commands_spec() ->
                        args_example = ["ejabberd@server2"],
                        args_desc = ["Name of erlang node to remove"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = num_active_users, tags = [accounts, stats],
                        desc = "Get number of users active in the last days",
@@ -158,7 +158,7 @@ get_commands_spec() ->
                        args_example = [<<"peter">>, <<"myserver.com">>],
                        args_desc = ["User name to check", "Server to check"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = check_password, tags = [accounts],
                        desc = "Check if a password is correct",
@@ -167,7 +167,7 @@ get_commands_spec() ->
                        args_example = [<<"peter">>, <<"myserver.com">>, <<"secret">>],
                        args_desc = ["User name to check", "Server to check", "Password to check"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = check_password_hash, tags = [accounts],
                        desc = "Check if the password hash is correct",
@@ -180,7 +180,7 @@ get_commands_spec() ->
                        args_desc = ["User name to check", "Server to check",
                                     "Password's hash value", "Name of hash method"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = change_password, tags = [accounts],
                        desc = "Change the password of an account",
@@ -190,7 +190,7 @@ get_commands_spec() ->
                        args_desc = ["User name", "Server name",
                                     "New password for user"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = ban_account, tags = [accounts],
                        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",
                                     "Reason for banning user"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = num_resources, tags = [session],
                        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",
                                     "Reason for closing session"],
                        result = {res, rescode},
-                       result_example = 0,
+                       result_example = ok,
                        result_desc = "Status code: 0 on success, 1 otherwise"},
      #ejabberd_commands{name = status_num_host, tags = [session, stats],
                        desc = "Number of logged users with this status in host",