update comments

2023-02-12 00:57:17 +08:00
parent 807e94e360
commit e7984776c8
7 changed files with 119 additions and 61 deletions
--- a/bot/playerlist/playerlist.go
+++ b/bot/playerlist/playerlist.go
@ -1,3 +1,9 @@
+// Package playerlist contains a PlayerList struct that used to manage player information.
+//
+// The [PlayerList] contains a list of [PlayerInfo] which is received from server when client join.
+// The playerlist contains every players' information of name, display name, uuid, gamemode, latency, public key, etc.
+// And can be used to render the "TAB List". Other packages may also require playerlist to work,
+// for example, the bot/msg package.
 package playerlist

 import (