From 34f56dc375a9171d6ba0c6b2a9702316136468cc Mon Sep 17 00:00:00 2001
From: Kim Alvefur <zash@zash.se>
Date: Fri, 9 Mar 2018 19:16:18 +0100
Subject: MUC: Write down which functions are exposed and thus available to
 other modules

---
 plugins/muc/mod_muc.lua | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'plugins/muc')

diff --git a/plugins/muc/mod_muc.lua b/plugins/muc/mod_muc.lua
index 3b25f997..83ed4900 100644
--- a/plugins/muc/mod_muc.lua
+++ b/plugins/muc/mod_muc.lua
@@ -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
-- 
cgit v1.2.3