aboutsummaryrefslogtreecommitdiff
path: root/include/ejabberd_commands.hrl
diff options
context:
space:
mode:
authorPaweł Chmielowski <pchmielowski@process-one.net>2015-12-28 12:19:49 +0100
committerPaweł Chmielowski <pchmielowski@process-one.net>2015-12-28 12:20:06 +0100
commita18a3dfbb17deac4484155cd32490e62a63d33f2 (patch)
treeb56237b15a8c536fdd89caea33196d0b4b76ff3e /include/ejabberd_commands.hrl
parentRestrict access to MAM archives for members-only rooms (diff)
Add commands for generating html or markdown documentation for commands
Diffstat (limited to '')
-rw-r--r--include/ejabberd_commands.hrl7
1 files changed, 5 insertions, 2 deletions
diff --git a/include/ejabberd_commands.hrl b/include/ejabberd_commands.hrl
index 82ee891c3..44f170e84 100644
--- a/include/ejabberd_commands.hrl
+++ b/include/ejabberd_commands.hrl
@@ -35,7 +35,11 @@
function :: atom(),
args = [] :: [aterm()] | '_' | '$1' | '$2',
policy = restricted :: open | restricted | admin | user,
- result = {res, rescode} :: rterm() | '_' | '$2'}).
+ result = {res, rescode} :: rterm() | '_' | '$2',
+ args_desc = none :: none | [string()] | '_',
+ result_desc = none :: none | string() | '_',
+ args_example = none :: none | [any()] | '_',
+ result_example = none :: any()}).
-type ejabberd_commands() :: #ejabberd_commands{name :: atom(),
tags :: [atom()],
@@ -72,4 +76,3 @@
%% @type rterm() = {Name::atom(), Type::rtype()}.
%% A result term is a tuple with the term name and the term type.
-