Przeglądaj źródła

fix golint: document exported symbols

Tao Wen 8 lat temu
rodzic
commit
8fbed91768

+ 2 - 0
extra/naming_strategy.go

@@ -5,6 +5,7 @@ import (
 	"unicode"
 )
 
+// SetNamingStrategy rename struct fields uniformly
 func SetNamingStrategy(translate func(string) string) {
 	jsoniter.RegisterExtension(&namingStrategyExtension{jsoniter.DummyExtension{}, translate})
 }
@@ -21,6 +22,7 @@ func (extension *namingStrategyExtension) UpdateStructDescriptor(structDescripto
 	}
 }
 
+// LowerCaseWithUnderscores one strategy to SetNamingStrategy for. It will change HelloWorld to hello_world.
 func LowerCaseWithUnderscores(name string) string {
 	newName := []rune{}
 	for i, c := range name {

+ 1 - 0
extra/privat_fields.go

@@ -5,6 +5,7 @@ import (
 	"unicode"
 )
 
+// SupportPrivateFields include private fields when encoding/decoding
 func SupportPrivateFields() {
 	jsoniter.RegisterExtension(&privateFieldsExtension{})
 }

+ 1 - 1
extra/time_as_int64_codec.go

@@ -6,7 +6,7 @@ import (
 	"unsafe"
 )
 
-// keep epoch milliseconds
+// RegisterTimeAsInt64Codec encode/decode time since number of unit since epoch. the precision is the unit.
 func RegisterTimeAsInt64Codec(precision time.Duration) {
 	jsoniter.RegisterTypeEncoder("time.Time", &timeAsInt64Codec{precision})
 	jsoniter.RegisterTypeDecoder("time.Time", &timeAsInt64Codec{precision})