docs: add godoc comments to all exported functions and methods

2026-07-30 00:20:55 +02:00
parent 56c97a2b3f
commit 0d6b6e1ab9
50 changed files with 186 additions and 408 deletions
@@ -19,6 +19,7 @@ type Item struct {
 var ItemsCache = make(map[string][]*Item)
 var ItemsCacheMutex = &sync.RWMutex{}

+// ItemsForVersion returns the item definitions for the given Minecraft version, caching them after the first load.
 func ItemsForVersion(v string) (ret []*Item) {
 	var ok bool
 	ItemsCacheMutex.RLock()
@@ -35,6 +36,7 @@ func ItemsForVersion(v string) (ret []*Item) {
 	return b
 }

+// LookupItemById returns the item with the given numeric ID in the given version.
 func LookupItemById(version string, id int32) (item *Item, ok bool) {
 	for _, i := range ItemsForVersion(version) {
 		if i.Id == id {
@@ -46,6 +48,7 @@ func LookupItemById(version string, id int32) (item *Item, ok bool) {
 	return
 }

+// LookupItemByName returns the item with the given name in the given version.
 func LookupItemByName(version string, name string) (item *Item, ok bool) {
 	for _, i := range ItemsForVersion(version) {
 		if i.Name == name {