documentation

Author: mcuadros

.travis.yml

@@ -1 +1,5 @@
-language: go
+language: go
+
+script:
+  - go get github.com/mcuadros/go-defaults
+  - go test

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Máximo Cuadros
+Copyright (c) 2014 Máximo Cuadros
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -27,14 +27,14 @@ import "github.com/mcuadros/go-defaults"
 import "fmt"
 
 type ExampleBasic struct {
-    Foo bool   `default:"true"`
+    Foo bool   `default:"true"` //<-- StructTag with a default key
     Bar string `default:"33"`
     Qux int8
 }
 
 func NewExampleBasic() *ExampleBasic {
     example := new(ExampleBasic)
-    SetDefaults(example)
+    SetDefaults(example) //<-- This set the defaults values
 
     return example
 }

defaults.go

@@ -10,6 +10,18 @@ type Field struct {
 	Value reflect.Value
 }
 
+// Apply the default values to the struct object, the struct type must have
+// the StructTag with name "default" and the directed value.
+//
+// Usage
+//     type ExampleBasic struct {
+//         Foo bool   `default:"true"`
+//         Bar string `default:"33"`
+//         Qux int8
+//     }
+//
+//      foo := &ExampleBasic{}
+//      SetDefaults(foo)
 func SetDefaults(variable interface{}) {
 	fields := getFields(variable)
 	setDefaultValues(fields)

doc.go

@@ -0,0 +1,5 @@
+/*
+This library allow to define a default value to any struct, this is made thanks
+to struct tags.
+*/
+package defaults