MUC: Write down which functions are exposed and thus available to other modules
authorKim Alvefur <zash@zash.se>
Fri, 09 Mar 2018 19:16:18 +0100
changeset 8575 ce1737520943
parent 8574 44217f40ff4a
child 8576 85e51205eef7
MUC: Write down which functions are exposed and thus available to other modules
plugins/muc/mod_muc.lua
--- a/plugins/muc/mod_muc.lua	Thu Mar 08 17:35:56 2018 +0100
+++ b/plugins/muc/mod_muc.lua	Fri Mar 09 19:16:18 2018 +0100
@@ -6,6 +6,16 @@
 -- COPYING file in the source package for more information.
 --
 
+-- Exposed functions:
+--
+-- create_room(jid) -> room
+-- track_room(room)
+-- delete_room(room)
+-- forget_room(room)
+-- get_room_from_jid(jid) -> room
+-- each_room(local_only) -> () -> room
+-- shutdown_component()
+
 if module:get_host_type() ~= "component" then
 	error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0);
 end