Fix some notes and add some comments.

irc/types.go

@@ -64,8 +64,10 @@ func (channels *ChannelNameMap) Len() int {
 	return len(channels.Chans)
 }
 
+// ModeSet holds a set of modes.
 type ModeSet map[Mode]bool
 
+// String returns the modes in this set.
 func (set ModeSet) String() string {
 	if len(set) == 0 {
 		return ""
@@ -79,35 +81,44 @@ func (set ModeSet) String() string {
 	return strings.Join(strs, "")
 }
 
+// ClientSet is a set of clients.
 type ClientSet map[*Client]bool
 
+// Add adds the given client to this set.
 func (clients ClientSet) Add(client *Client) {
 	clients[client] = true
 }
 
+// Remove removes the given client from this set.
 func (clients ClientSet) Remove(client *Client) {
 	delete(clients, client)
 }
 
+// Has returns true if the given client is in this set.
 func (clients ClientSet) Has(client *Client) bool {
 	return clients[client]
 }
 
+// MemberSet is a set of members with modes.
 type MemberSet map[*Client]ModeSet
 
+// Add adds the given client to this set.
 func (members MemberSet) Add(member *Client) {
 	members[member] = make(ModeSet)
 }
 
+// Remove removes the given client from this set.
 func (members MemberSet) Remove(member *Client) {
 	delete(members, member)
 }
 
+// Has returns true if the given client is in this set.
 func (members MemberSet) Has(member *Client) bool {
 	_, ok := members[member]
 	return ok
 }
 
+// HasMode returns true if the given client is in this set with the given mode.
 func (members MemberSet) HasMode(member *Client, mode Mode) bool {
 	modes, ok := members[member]
 	if !ok {
@@ -116,6 +127,7 @@ func (members MemberSet) HasMode(member *Client, mode Mode) bool {
 	return modes[mode]
 }
 
+// AnyHasMode returns true if any of our clients has the given mode.
 func (members MemberSet) AnyHasMode(mode Mode) bool {
 	for _, modes := range members {
 		if modes[mode] {
@@ -125,19 +137,15 @@ func (members MemberSet) AnyHasMode(mode Mode) bool {
 	return false
 }
 
+// ChannelSet is a set of channels.
 type ChannelSet map[*Channel]bool
 
+// Add adds the given channel to this set.
 func (channels ChannelSet) Add(channel *Channel) {
 	channels[channel] = true
 }
 
+// Remove removes the given channel from this set.
 func (channels ChannelSet) Remove(channel *Channel) {
 	delete(channels, channel)
 }
-
-func (channels ChannelSet) First() *Channel {
-	for channel := range channels {
-		return channel
-	}
-	return nil
-}