dkforest

commit a9bc4dd8e8a0beeb89718f11633283946f0f21bb
parent d9b11d704535b272b02c67fc440d31e8629a786e
Author: n0tr1v <n0tr1v@protonmail.com>
Date:   Mon, 22 May 2023 04:24:21 -0700

Add doc

Diffstat:
M
pkg/web/handlers/api/v1/handlers.go
 | 
3
+++

1 file changed, 3 insertions(+), 0 deletions(-)
diff --git a/pkg/web/handlers/api/v1/handlers.go b/pkg/web/handlers/api/v1/handlers.go
@@ -86,6 +86,9 @@ var memeRenameRgx = regexp.MustCompile(`^/meme ([a-zA-Z0-9_-]{3,50}) ([a-zA-Z0-9
 var memeRemoveRgx = regexp.MustCompile(`^/memerm ([a-zA-Z0-9_-]{3,50})$`)
 var memesRgx = regexp.MustCompile(`^/memes$`)
 
+// GetChatMenuData gets the data needed to render the "right-menu" in a chat room.
+// We have it separate because we have one endpoint that only render the right menu (for "stream" chat).
+// and one endpoint to render both messages and menu ("non-stream" chat).
 func GetChatMenuData(c echo.Context, room database.ChatRoom) ChatMenuData {
 	db := c.Get("database").(*database.DkfDB)
 	authUser := c.Get("authUser").(*database.User)