aboutsummaryrefslogtreecommitdiff
path: root/src/mod_muc_admin.erl
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2022-05-12 17:25:11 +0200
committerBadlop <badlop@process-one.net>2022-05-17 10:42:02 +0200
commit4f8e6fe844804fba59904702d0ef2688958e8852 (patch)
tree8d3f06b41b76c688ddcfce7698787302d5d4e34f /src/mod_muc_admin.erl
parentDefine license for hex.pm using SPDX identifier (diff)
Fix errors and warnings for "rebar3 edoc"
Diffstat (limited to 'src/mod_muc_admin.erl')
-rw-r--r--src/mod_muc_admin.erl10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/mod_muc_admin.erl b/src/mod_muc_admin.erl
index 891f55e96..9651cfe11 100644
--- a/src/mod_muc_admin.erl
+++ b/src/mod_muc_admin.erl
@@ -695,8 +695,7 @@ justcreated_to_binary(J) when is_atom(J) ->
%% Create/Delete Room
%%----------------------------
-%% @spec (Name::binary(), Host::binary(), ServerHost::binary()) ->
-%% ok | error
+-spec create_room(Name::binary(), Host::binary(), ServerHost::binary()) -> ok | error.
%% @doc Create a room immediately with the default options.
create_room(Name1, Host1, ServerHost) ->
create_room_with_opts(Name1, Host1, ServerHost, []).
@@ -747,8 +746,7 @@ muc_create_room(ServerHost, {Name, Host, _}, DefRoomOpts) ->
io:format("Creating room ~ts@~ts~n", [Name, Host]),
mod_muc:store_room(ServerHost, Host, Name, DefRoomOpts).
-%% @spec (Name::binary(), Host::binary()) ->
-%% ok | {error, room_not_exists}
+-spec destroy_room(Name::binary(), Host::binary()) -> ok | {error, room_not_exists}.
%% @doc Destroy the room immediately.
%% If the room has participants, they are not notified that the room was destroyed;
%% they will notice when they try to chat and receive an error that the room doesn't exist.
@@ -1116,8 +1114,8 @@ send_direct_invitation(FromJid, UserJid, Msg) ->
%% Change Room Option
%%----------------------------
-%% @spec(Name::string(), Service::string(), Option::string(), Value) -> ok
-%% Value = atom() | integer() | string()
+-spec change_room_option(Name::binary(), Service::binary(), Option::binary(),
+ Value::atom() | integer() | string()) -> ok | mod_muc_log_not_enabled.
%% @doc Change an option in an existing room.
%% Requires the name of the room, the MUC service where it exists,
%% the option to change (for example title or max_users),