From 259b3a228aa60086eb2b3357ec829ecc885f2e92 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vin=C3=ADcius=20Garcia?= <vingarcia00@gmail.com>
Date: Tue, 13 Dec 2022 22:34:54 -0300
Subject: [PATCH] Add some comments to internal/structs/structs.go

---
 internal/structs/structs.go | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/internal/structs/structs.go b/internal/structs/structs.go
index e21bd56..fbf77e9 100644
--- a/internal/structs/structs.go
+++ b/internal/structs/structs.go
@@ -23,11 +23,24 @@ type StructInfo struct {
 // information regarding a specific field
 // of a struct.
 type FieldInfo struct {
-	AttrName   string
+	// AttrName is the name of struct attribute of the struct.
+	AttrName string
+
+	// ColumnName is the name of the database column described by the ksql tag.
 	ColumnName string
-	Index      int
-	Valid      bool
-	Modifier   ksqlmodifiers.AttrModifier
+
+	// Index indexes the position of this attribute on the struct.
+	// This field is meant to be used together with the
+	// `reflect.Value.Field()` and `reflect.Type.Field()` methods.
+	Index int
+
+	// Valid will only be set to false if the instance
+	// of this field was not initialized, i.e.
+	// it denotes the zero value of a FieldInfo.
+	Valid bool
+
+	// Modifier contains the AttrModifier associated with this field.
+	Modifier ksqlmodifiers.AttrModifier
 }
 
 // ByIndex returns either the *FieldInfo of a valid