builder documentation

Author: Ompluscator

builder.go

@@ -3,20 +3,70 @@ package dynamicstruct
 import "reflect"
 
 type (
+	// Builder holds all fields' definitions for desired structs.
+	// It gives opportunity to add or remove fields, or to edit
+	// existing ones. In the end, it provides definition for
+	// dynamic structs, used to create new instances.
 	Builder interface {
+		// AddField creates new struct's field.
+		// It expects field's name, type and string.
+		// Type is provided as an instance of some golang type.
+		// Tag is provided as classical golang field tag.
+		//
+		// builder.AddField("SomeFloatField", 0.0, `json:"boolean" validate:"gte=10"`)
+		//
 		AddField(name string, typ interface{}, tag string) Builder
+		// RemoveField removes existing struct's field.
+		//
+		// builder.RemoveField("SomeFloatField")
+		//
 		RemoveField(name string) Builder
+		// HasField checks if struct has a field with a given name.
+		//
+		// if builder.HasField("SomeFloatField") { ...
+		//
 		HasField(name string) bool
+		// GetField returns struct's field definition.
+		// If there is no such field, it returns nil.
+		// Usable to edit existing struct's field.
+		//
+		// field := builder.GetField("SomeFloatField")
+		//
 		GetField(name string) FieldConfig
+		// Build returns definition for dynamic struct.
+		// Definition can be used to create new instances.
+		//
+		// dStruct := builder.Build()
+		//
 		Build() DynamicStruct
 	}
 
+	// FieldConfig holds single field's definition.
+	// It provides possibility to edit field's type and tag.
 	FieldConfig interface {
+		// SetType changes field's type.
+		// Expected value is an instance of golang type.
+		//
+		// field.SetType([]int{})
+		//
 		SetType(typ interface{}) FieldConfig
+		// SetTag changes fields's tag.
+		// Expected value is an string which represents classical
+		// golang tag.
+		//
+		// field.SetTag(`json:"slice"`)
+		//
 		SetTag(tag string) FieldConfig
 	}
 
+	// DynamicStruct contains defined dynamic struct.
+	// This definition can't be changed anymore, once is built.
+	// It provides a method for creating new instances of same defintion.
 	DynamicStruct interface {
+		// New provides new instance of defined dynamic struct.
+		//
+		// value := dStruct.New()
+		//
 		New() interface{}
 	}
 
@@ -34,16 +84,31 @@ type (
 	}
 )
 
+// NewStruct returns new clean instance of Builder interface
+// for defining fresh dynamic struct.
+//
+// builder := dynamicstruct.NewStruct()
+//
 func NewStruct() Builder {
 	return &builderImpl{
 		fields: map[string]*fieldConfigImpl{},
 	}
 }
 
+// ExtendStruct extends existing instance of struct and
+// returns new instance of Builder interface.
+//
+// builder := dynamicstruct.MergeStructs(MyStruct{})
+//
 func ExtendStruct(value interface{}) Builder {
 	return MergeStructs(value)
 }
 
+// MergeStructs merges a list of existing instances of structs and
+// returns new instance of Builder interface.
+//
+// builder := dynamicstruct.MergeStructs(MyStructOne{}, MyStructTwo{}, MyStructThree{})
+//
 func MergeStructs(values ...interface{}) Builder {
 	builder := NewStruct()