Ensure all exported functions and types have descriptive comments

This commit is contained in:
2018-07-08 18:38:35 +01:00
parent 2b9fece77f
commit a6cc988f5e
4 changed files with 26 additions and 0 deletions

View File

@@ -1,5 +1,7 @@
package obj
// NewEntry returns a new *Entry instance initialized with a *Object of the
// given input JSON data.
func NewEntry(inputJSON []byte) (*Entry, error) {
obj, err := NewObject(inputJSON)
if err != nil {
@@ -19,6 +21,7 @@ type Entry struct {
Index string
}
// Address returns the Address property of the entry's Object.
func (s *Entry) Address() string {
return s.Object.Address
}