From 8fbed91768da7ec837f4e2c793d0d5538d307646 Mon Sep 17 00:00:00 2001 From: Tao Wen Date: Sun, 9 Jul 2017 14:17:40 +0800 Subject: [PATCH] fix golint: document exported symbols --- extra/naming_strategy.go | 2 ++ extra/privat_fields.go | 1 + extra/time_as_int64_codec.go | 2 +- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/extra/naming_strategy.go b/extra/naming_strategy.go index afae7e3..642556f 100644 --- a/extra/naming_strategy.go +++ b/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 { diff --git a/extra/privat_fields.go b/extra/privat_fields.go index 6ca7a5f..1864396 100644 --- a/extra/privat_fields.go +++ b/extra/privat_fields.go @@ -5,6 +5,7 @@ import ( "unicode" ) +// SupportPrivateFields include private fields when encoding/decoding func SupportPrivateFields() { jsoniter.RegisterExtension(&privateFieldsExtension{}) } diff --git a/extra/time_as_int64_codec.go b/extra/time_as_int64_codec.go index 333b7e9..e270cd4 100644 --- a/extra/time_as_int64_codec.go +++ b/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})