diff options
| author | Badlop <badlop@process-one.net> | 2017-07-21 11:18:44 +0200 |
|---|---|---|
| committer | Badlop <badlop@process-one.net> | 2017-07-21 11:26:53 +0200 |
| commit | 1a0db3de3a6ab53557772f2db8a84de771d46f87 (patch) | |
| tree | d09da15e1c803b5d1af9cc6c2d666f0c9ea9e464 /src/ext_mod.erl | |
| parent | Fix indentation of commands lines (diff) | |
Describe commands arguments and results in ejabberd_sm, ext_mod, mod_mam
Diffstat (limited to 'src/ext_mod.erl')
| -rw-r--r-- | src/ext_mod.erl | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/src/ext_mod.erl b/src/ext_mod.erl index 86bd21983..6b3f7d548 100644 --- a/src/ext_mod.erl +++ b/src/ext_mod.erl @@ -80,16 +80,18 @@ code_change(_OldVsn, State, _Extra) -> get_commands_spec() -> [#ejabberd_commands{name = modules_update_specs, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "Update the module source code from Git", + longdesc = "A connection to Internet is required", module = ?MODULE, function = update, args = [], result = {res, rescode}}, #ejabberd_commands{name = modules_available, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "List the contributed modules available to install", module = ?MODULE, function = available_command, + result_desc = "List of tuples with module name and description", + result_example = [{mod_cron, "Execute scheduled commands"}, + {mod_rest, "ReST frontend"}], args = [], result = {modules, {list, {module, {tuple, @@ -97,9 +99,11 @@ get_commands_spec() -> {summary, string}]}}}}}, #ejabberd_commands{name = modules_installed, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "List the contributed modules already installed", module = ?MODULE, function = installed_command, + result_desc = "List of tuples with module name and description", + result_example = [{mod_cron, "Execute scheduled commands"}, + {mod_rest, "ReST frontend"}], args = [], result = {modules, {list, {module, {tuple, @@ -107,30 +111,35 @@ get_commands_spec() -> {summary, string}]}}}}}, #ejabberd_commands{name = module_install, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "Compile, install and start an available contributed module", module = ?MODULE, function = install, + args_desc = "Module name", + args_example = mod_rest, args = [{module, binary}], result = {res, rescode}}, #ejabberd_commands{name = module_uninstall, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "Uninstall a contributed module", module = ?MODULE, function = uninstall, + args_desc = "Module name", + args_example = mod_rest, args = [{module, binary}], result = {res, rescode}}, #ejabberd_commands{name = module_upgrade, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "Upgrade the running code of an installed module", + longdesc = "In practice, this uninstalls and installs the module", module = ?MODULE, function = upgrade, + args_desc = "Module name", + args_example = mod_rest, args = [{module, binary}], result = {res, rescode}}, #ejabberd_commands{name = module_check, tags = [admin,modules], - desc = "", - longdesc = "", + desc = "Check the contributed module repository compliance", module = ?MODULE, function = check, + args_desc = "Module name", + args_example = mod_rest, args = [{module, binary}], result = {res, rescode}} ]. |