docs: add godoc comments to all exported functions and methods

mc/nbt/file.go

@@ -10,6 +10,7 @@ import (
 
 var Format = mapstructure.NewFormat("nbt", mapstructure.WithRequireAll(), mapstructure.WithTrySnakeCase(), mapstructure.WithTryLowCase())
 
+// ReadFile reads a gzipped NBT file from r and decodes it into data using the package-level Format.
 func ReadFile(file io.Reader, data any) (err error) {
 	n, err := ReadUnstructuredFile(file)
 	if err != nil {
@@ -18,6 +19,7 @@ func ReadFile(file io.Reader, data any) (err error) {
 	return Format.Decode(n.Value, data)
 }
 
+// WriteUnstructuredFilePath writes an NBT tag as a gzipped file to the given filesystem path.
 func WriteUnstructuredFilePath(path string, n *Tag) (err error) {
 	f, err := os.Create(path)
 	if err != nil {
@@ -27,6 +29,7 @@ func WriteUnstructuredFilePath(path string, n *Tag) (err error) {
 	return WriteUnstructuredFile(f, n)
 }
 
+// WriteUnstructuredFile writes an NBT tag as a gzipped file to w.
 func WriteUnstructuredFile(file io.Writer, n *Tag) (err error) {
 	gzw := gzip.NewWriter(file)
 	defer gzw.Close()
@@ -34,6 +37,7 @@ func WriteUnstructuredFile(file io.Writer, n *Tag) (err error) {
 	return
 }
 
+// ReadUnstructuredFile reads a gzipped NBT file from r and returns the root Tag.
 func ReadUnstructuredFile(file io.Reader) (n *Tag, err error) {
 	r, err := gzip.NewReader(file)
 	if err != nil {
@@ -45,6 +49,7 @@ func ReadUnstructuredFile(file io.Reader) (n *Tag, err error) {
 	return
 }
 
+// ReadUnstructuredFilePath reads a gzipped NBT file from the given filesystem path and returns the root Tag.
 func ReadUnstructuredFilePath(path string) (n *Tag, err error) {
 	f, err := os.Open(path)
 	if err != nil {