From 6af2ee933015e08d24bd4f3dc01b25fe2629f6f7 Mon Sep 17 00:00:00 2001
From: chotaire <chotaire@chotaire.net>
Date: Fri, 19 Apr 2019 01:40:39 +0200
Subject: [PATCH] Added documentation to outmessage-irccolors

---
 contrib/outmessage-irccolors.tengo | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/contrib/outmessage-irccolors.tengo b/contrib/outmessage-irccolors.tengo
index fe63da43..85f2a6b2 100644
--- a/contrib/outmessage-irccolors.tengo
+++ b/contrib/outmessage-irccolors.tengo
@@ -1,5 +1,16 @@
-// See https://github.com/42wim/matterbridge/issues/798
+/*
+variables available 
+read-only:
+inAccount, inProtocol, inChannel, inGateway
+outAccount, outProtocol, outChannel, outGateway
 
+read-write:
+msgText, msgUsername
+*/
+
+text := import("text")
+
+// See https://github.com/42wim/matterbridge/issues/798
 // if we're not sending to an irc bridge we strip the IRC colors
 if outProtocol != "irc" {
     re := text.re_compile(`\x03(?:\d{1,2}(?:,\d{1,2})?)?|[[:cntrl:]]`)