fix docs of exported funcs

Author: markus-wa

internal/constants/constants.go

@@ -1,6 +1,7 @@
 // Package constants contains constants that are used internally across the demoinfocs library.
 package constants
 
+// Various constants tat are used internally.
 const (
 	MaxEdictBits                 = 11
 	EntityHandleIndexMask        = (1 << MaxEdictBits) - 1

pkg/demoinfocs/common/common.go

@@ -191,7 +191,7 @@ func (ts *TeamState) MoneySpentThisRound() (value int) {
 	return
 }
 
-// MoneySpentThisRound returns the total amount of cash spent by the whole team during the whole game up to the current point.
+// MoneySpentTotal returns the total amount of cash spent by the whole team during the whole game up to the current point.
 func (ts *TeamState) MoneySpentTotal() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.MoneySpentTotal()

pkg/demoinfocs/common/equipment.go

@@ -270,8 +270,10 @@ func MapEquipment(eqName string) EquipmentType {
 	return wep
 }
 
+// ZoomLevel contains how far a player is zoomed in.
 type ZoomLevel int
 
+// All currently known zoom levels.
 const (
 	ZoomNone ZoomLevel = 0
 	ZoomHalf ZoomLevel = 1

pkg/demoinfocs/events/events.go

@@ -289,7 +289,7 @@ type BombPlantBegin struct {
 	BombEvent
 }
 
-// BombPlantAbort signals the abortion of a plant.
+// BombPlantAborted signals the abortion of a plant.
 type BombPlantAborted struct {
 	Player *common.Player
 }

pkg/demoinfocs/sendtables/fake/entity.go

@@ -8,6 +8,7 @@ import (
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 )
 
+// NewEntityWithProperty creates and returns an entity with a single mocked property.
 func NewEntityWithProperty(name string, val st.PropertyValue) *Entity {
 	entity := new(Entity)