re
/
enumer
forked from mirror/enumer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix generated comments 

- Add missing punctuation marks.
- Make comments more consistent with comments for similar functions
  in the standard library.
This commit is contained in:
Michael Gaffney 2019-03-01 15:36:43 -05:00
parent da4a0ea77c
commit f84898d4c3
No known key found for this signature in database
GPG Key ID: 21FE4844A1193A56
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
enumer.go
View File

@ -4,8 +4,8 @@ import "fmt"
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const stringNameToValueMethod = `// %[1]sString retrieves an enum value from the enum constants string name. const stringNameToValueMethod = `// %[1]sString returns a %[1]s for s.
// Throws an error if the param is not part of the enum. // It returns an error if s is not a %[1]s.
func %[1]sString(s string) (%[1]s, error) { func %[1]sString(s string) (%[1]s, error) {
if val, ok := _%[1]sNameToValueMap[s]; ok { if val, ok := _%[1]sNameToValueMap[s]; ok {
return val, nil return val, nil
@ -16,7 +16,7 @@ func %[1]sString(s string) (%[1]s, error) {
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const stringValuesMethod = `// %[1]sValues returns all values of the enum const stringValuesMethod = `// %[1]sValues returns all values of the enum.
func %[1]sValues() []%[1]s { func %[1]sValues() []%[1]s {
return _%[1]sValues return _%[1]sValues
} }
@ -24,7 +24,7 @@ func %[1]sValues() []%[1]s {
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const stringBelongsMethodLoop = `// IsA%[1]s returns "true" if the value is listed in the enum definition. "false" otherwise const stringBelongsMethodLoop = `// IsA%[1]s reports whether the value is a member of the enum.
func (i %[1]s) IsA%[1]s() bool { func (i %[1]s) IsA%[1]s() bool {
for _, v := range _%[1]sValues { for _, v := range _%[1]sValues {
if i == v { if i == v {
@ -37,9 +37,9 @@ func (i %[1]s) IsA%[1]s() bool {
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const stringBelongsMethodSet = `// IsA%[1]s returns "true" if the value is listed in the enum definition. "false" otherwise const stringBelongsMethodSet = `// IsA%[1]s reports whether the value is a member of the enum.
func (i %[1]s) IsA%[1]s() bool { func (i %[1]s) IsA%[1]s() bool {
_, ok := _%[1]sMap[i] _, ok := _%[1]sMap[i]
return ok return ok
} }
` `
@ -88,13 +88,12 @@ func (g *Generator) buildBasicExtras(runs [][]Value, typeName string, runsThresh
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const jsonMethods = ` const jsonMethods = `// MarshalJSON implements the json.Marshaler interface.
// MarshalJSON implements the json.Marshaler interface for %[1]s
func (i %[1]s) MarshalJSON() ([]byte, error) { func (i %[1]s) MarshalJSON() ([]byte, error) {
return json.Marshal(i.String()) return json.Marshal(i.String())
} }
// UnmarshalJSON implements the json.Unmarshaler interface for %[1]s // UnmarshalJSON implements the json.Unmarshaler interface.
func (i *%[1]s) UnmarshalJSON(data []byte) error { func (i *%[1]s) UnmarshalJSON(data []byte) error {
var s string var s string
if err := json.Unmarshal(data, &s); err != nil { if err := json.Unmarshal(data, &s); err != nil {
@ -114,12 +113,12 @@ func (g *Generator) buildJSONMethods(runs [][]Value, typeName string, runsThresh
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const textMethods = ` const textMethods = `
// MarshalText implements the encoding.TextMarshaler interface for %[1]s // MarshalText implements the encoding.TextMarshaler interface.
func (i %[1]s) MarshalText() ([]byte, error) { func (i %[1]s) MarshalText() ([]byte, error) {
return []byte(i.String()), nil return []byte(i.String()), nil
} }
// UnmarshalText implements the encoding.TextUnmarshaler interface for %[1]s // UnmarshalText implements the encoding.TextUnmarshaler interface.
func (i *%[1]s) UnmarshalText(text []byte) error { func (i *%[1]s) UnmarshalText(text []byte) error {
var err error var err error
*i, err = %[1]sString(string(text)) *i, err = %[1]sString(string(text))
@ -133,13 +132,12 @@ func (g *Generator) buildTextMethods(runs [][]Value, typeName string, runsThresh
// Arguments to format are: // Arguments to format are:
// [1]: type name // [1]: type name
const yamlMethods = ` const yamlMethods = `// MarshalYAML implements the yaml.Marshaler interface.
// MarshalYAML implements a YAML Marshaler for %[1]s
func (i %[1]s) MarshalYAML() (interface{}, error) { func (i %[1]s) MarshalYAML() (interface{}, error) {
return i.String(), nil return i.String(), nil
} }
// UnmarshalYAML implements a YAML Unmarshaler for %[1]s // UnmarshalYAML implements the yaml.Unmarshaler interface.
func (i *%[1]s) UnmarshalYAML(unmarshal func(interface{}) error) error { func (i *%[1]s) UnmarshalYAML(unmarshal func(interface{}) error) error {
var s string var s string
if err := unmarshal(&s); err != nil { if err := unmarshal(&s); err != nil {