godoc cleanups

Author: moorereason

definitions.go

@@ -5,13 +5,13 @@ import (
 	"github.com/goadesign/goa/dslengine"
 )
 
-// RelationalStorageType is the type of database
+// RelationalStorageType is the type of database.
 type RelationalStorageType string
 
-// FieldType is the storage data type for a database field
+// FieldType is the storage data type for a database field.
 type FieldType string
 
-// StorageGroupDefinition is the parent configuration structure for Gorma definitions
+// StorageGroupDefinition is the parent configuration structure for Gorma definitions.
 type StorageGroupDefinition struct {
 	dslengine.Definition
 	DefinitionDSL    func()
@@ -20,7 +20,7 @@ type StorageGroupDefinition struct {
 	RelationalStores map[string]*RelationalStoreDefinition
 }
 
-// RelationalStoreDefinition is the parent configuration structure for Gorm relational model definitions
+// RelationalStoreDefinition is the parent configuration structure for Gorm relational model definitions.
 type RelationalStoreDefinition struct {
 	dslengine.Definition
 	DefinitionDSL    func()
@@ -35,7 +35,7 @@ type RelationalStoreDefinition struct {
 }
 
 // RelationalModelDefinition implements the storage of a domain model into a
-// table in a relational database
+// table in a relational database.
 type RelationalModelDefinition struct {
 	dslengine.Definition
 	*design.UserTypeDefinition
@@ -63,7 +63,7 @@ type RelationalModelDefinition struct {
 }
 
 // BuildSource stores the BuildsFrom sources
-// for parsing
+// for parsing.
 type BuildSource struct {
 	dslengine.Definition
 	DefinitionDSL   func()
@@ -72,15 +72,16 @@ type BuildSource struct {
 }
 
 // MapDefinition represents field mapping to and from
-// Gorma models
+// Gorma models.
 type MapDefinition struct {
 	RemoteType  *design.UserTypeDefinition
 	RemoteField string
 }
 
 // MediaTypeAdapterDefinition represents the transformation of a
-// Goa media type into a Gorma Model
-// Unimplemented at this time
+// Goa media type into a Gorma Model.
+//
+// Unimplemented at this time.
 type MediaTypeAdapterDefinition struct {
 	dslengine.Definition
 	DefinitionDSL func()
@@ -91,8 +92,9 @@ type MediaTypeAdapterDefinition struct {
 }
 
 // UserTypeAdapterDefinition represents the transformation of a Goa
-// user type into a Gorma Model
-// Unimplemented at this time
+// user type into a Gorma Model.
+//
+// Unimplemented at this time.
 type UserTypeAdapterDefinition struct {
 	dslengine.Definition
 	DefinitionDSL func()
@@ -103,9 +105,10 @@ type UserTypeAdapterDefinition struct {
 }
 
 // PayloadAdapterDefinition represents the transformation of a Goa
-// Payload (which is really a UserTypeDefinition
-// into a Gorma model
-// Unimplemented at this time
+// Payload (which is really a UserTypeDefinition)
+// into a Gorma model.
+//
+// Unimplemented at this time.
 type PayloadAdapterDefinition struct {
 	dslengine.Definition
 	DefinitionDSL func()
@@ -116,7 +119,7 @@ type PayloadAdapterDefinition struct {
 }
 
 // RelationalFieldDefinition represents
-// a field in a relational database
+// a field in a relational database.
 type RelationalFieldDefinition struct {
 	dslengine.Definition
 	DefinitionDSL     func()
@@ -140,7 +143,7 @@ type RelationalFieldDefinition struct {
 }
 
 // ManyToManyDefinition stores information about a ManyToMany
-// relationship between two domain objects
+// relationship between two domain objects.
 type ManyToManyDefinition struct {
 	dslengine.Definition
 	DefinitionDSL    func()
@@ -151,17 +154,17 @@ type ManyToManyDefinition struct {
 }
 
 // StoreIterator is a function that iterates over Relational Stores in a
-// StorageGroup
+// StorageGroup.
 type StoreIterator func(m *RelationalStoreDefinition) error
 
 // ModelIterator is a function that iterates over Models in a
-// RelationalStore
+// RelationalStore.
 type ModelIterator func(m *RelationalModelDefinition) error
 
 // FieldIterator is a function that iterates over Fields
-// in a RelationalModel
+// in a RelationalModel.
 type FieldIterator func(m *RelationalFieldDefinition) error
 
 // BuildSourceIterator is a function that iterates over Fields
-// in a RelationalModel
+// in a RelationalModel.
 type BuildSourceIterator func(m *BuildSource) error

dsl/relationalfield.go

@@ -13,14 +13,18 @@ import (
 
 // Field is a DSL definition for a field in a Relational Model.
 // Parameter Options:
-// A field called "Title" with type String
-// Field("Title")
-// Explicitly specify the type
-// Field("Title", gorma.String)
-// "Title" field, as String with other DSL included
-// Field("Title", func(){... other field level dsl ...})
-// All options specified, name, type and dsl
-// Field("Title", gorma.String, func(){... other field level dsl ...})
+//
+//	// A field called "Title" with default type `String`.
+//	Field("Title")
+//
+//	// Explicitly specify the type.
+//	Field("Title", gorma.String)
+//
+//	// "Title" field, as `String` with other DSL included.
+//	Field("Title", func(){... other field level dsl ...})
+//
+//	// All options specified: name, type and dsl.
+//	Field("Title", gorma.String, func(){... other field level dsl ...})
 func Field(name string, args ...interface{}) {
 	// We can't rely on this being run first, any of the top level DSL could run
 	// in any order. The top level DSLs are API, Version, Resource, MediaType and Type.

dsl/relationalmodel.go

@@ -17,6 +17,7 @@ import (
 // to define the mapping between a Model and a Goa Type.
 // Models may contain multiple instances of the `Field` DSL to
 // add fields to the model.
+//
 // To control whether the ID field is auto-generated, use `NoAutomaticIDFields()`
 // Similarly, use NoAutomaticTimestamps() and NoAutomaticSoftDelete() to
 // prevent CreatedAt, UpdatedAt and DeletedAt fields from being created.
@@ -83,7 +84,8 @@ func Model(name string, dsl func()) {
 // RendersTo informs Gorma that this model will need to be
 // rendered to a Goa type.  Conversion functions
 // will be generated to convert to/from the model.
-// Usage:   RendersTo(MediaType)
+//
+// Usage: RendersTo(MediaType)
 func RendersTo(rt interface{}) {
 	checkInit()
 	if m, ok := relationalModelDefinition(false); ok {
@@ -98,7 +100,9 @@ func RendersTo(rt interface{}) {
 // BuildsFrom informs Gorma that this model will be populated
 // from a Goa UserType.  Conversion functions
 // will be generated to convert from the payload to the model.
+//
 // Usage:  BuildsFrom(YourType)
+//
 // Fields not in `YourType` that you want in your model must be
 // added explicitly with the `Field` DSL.
 func BuildsFrom(dsl func()) {
@@ -121,7 +125,7 @@ func BuildsFrom(dsl func()) {
 }
 
 // Payload specifies the Resource and Action containing
-// a User Type (Payload)
+// a User Type (Payload).
 // Gorma will generate a conversion function for the Payload to
 // the Model.
 func Payload(r interface{}, act string) {
@@ -155,6 +159,7 @@ func Payload(r interface{}, act string) {
 // BelongsTo signifies a relationship between this model and a
 // Parent.  The Parent has the child, and the Child belongs
 // to the Parent.
+//
 // Usage:  BelongsTo("User")
 func BelongsTo(parent string) {
 	if r, ok := relationalModelDefinition(false); ok {
@@ -182,6 +187,7 @@ func BelongsTo(parent string) {
 // to have a ThisModelID field as a Foreign Key to this model's
 // Primary Key.  ThisModel will have a field named OtherModel of type
 // OtherModel.
+//
 // Usage:  HasOne("Proposal")
 func HasOne(child string) {
 	if r, ok := relationalModelDefinition(false); ok {
@@ -232,7 +238,9 @@ func HasOne(child string) {
 // of the child model.  The Child model will have a ParentID field
 // appended to the field list.  The Parent model definition will use
 // the first parameter as the field name in the struct definition.
+//
 // Usage:  HasMany("Orders", "Order")
+//
 // Generated struct field definition:  Children	[]Child
 func HasMany(name, child string) {
 	if r, ok := relationalModelDefinition(false); ok {
@@ -279,9 +287,11 @@ func HasMany(name, child string) {
 // between this model and another model.  For example, in retail an Order can
 // contain many products, and a product can belong to many orders.  To express
 // this relationship use the following syntax:
-// Model("Order", func(){
-//    ManyToMany("Product", "order_lines")
-// })
+//
+//		Model("Order", func(){
+//			ManyToMany("Product", "order_lines")
+//		})
+//
 // This specifies that the Order and Product tables have a "junction" table
 // called `order_lines` that contains the order and product information.
 // The generated model will have a field called `Products` that will

init.go

@@ -61,9 +61,9 @@ const (
 	BelongsTo FieldType = "belongsto"
 )
 
-// Init creates the necessary data structures for parsing a DSL
+// Init creates the necessary data structures for parsing a DSL.
 // Should not be called directly, but instead is called
-// by many of the DSL functions to ensure that the design is initialized
+// by many of the DSL functions to ensure that the design is initialized.
 func Init() {
 	sg := NewStorageGroupDefinition()
 	dslengine.Roots = append(dslengine.Roots, sg)

manytomany.go

@@ -7,37 +7,37 @@ import (
 )
 
 // LeftNamePlural returns the pluralized version of
-// the "owner" of the m2m relationship
+// the "owner" of the m2m relationship.
 func (m *ManyToManyDefinition) LeftNamePlural() string {
 	return inflect.Pluralize(m.Left.ModelName)
 }
 
 // RightNamePlural returns the pluralized version
-// of the "child" of the m2m relationship
+// of the "child" of the m2m relationship.
 func (m *ManyToManyDefinition) RightNamePlural() string {
 	return inflect.Pluralize(m.Right.ModelName)
 }
 
 // LeftName returns the name of the "owner" of the
-// m2m relationship
+// m2m relationship.
 func (m *ManyToManyDefinition) LeftName() string {
 	return m.Left.ModelName
 }
 
 // RightName returns the name of the "child" of the
-// m2m relationship
+// m2m relationship.
 func (m *ManyToManyDefinition) RightName() string {
 	return m.Right.ModelName
 }
 
 // LowerLeftName returns the lower case name of the "owner" of the
-// m2m relationship
+// m2m relationship.
 func (m *ManyToManyDefinition) LowerLeftName() string {
 	return strings.ToLower(m.Left.ModelName)
 }
 
 // LowerRightName returns the name of the "child" of the
-// m2m relationship
+// m2m relationship.
 func (m *ManyToManyDefinition) LowerRightName() string {
 	return strings.ToLower(m.Right.ModelName)
 }

mapdefinition.go

@@ -1,7 +1,7 @@
 package gorma
 
 // NewMapDefinition returns an initialized
-// MapDefinition
+// MapDefinition.
 func NewMapDefinition() *MapDefinition {
 	return &MapDefinition{}
 }

relationalfield.go

@@ -10,7 +10,7 @@ import (
 )
 
 // NewRelationalFieldDefinition returns an initialized
-// RelationalFieldDefinition
+// RelationalFieldDefinition.
 func NewRelationalFieldDefinition() *RelationalFieldDefinition {
 	m := &RelationalFieldDefinition{
 		Mappings: make(map[string]*MapDefinition),
@@ -26,25 +26,24 @@ func (f *RelationalFieldDefinition) Context() string {
 	return "unnamed RelationalField"
 }
 
-// DSL returns this object's DSL
+// DSL returns this object's DSL.
 func (f *RelationalFieldDefinition) DSL() func() {
 	return f.DefinitionDSL
 }
 
-// Children returnsa slice of this objects children
+// Children returns a slice of this objects children.
 func (f RelationalFieldDefinition) Children() []dslengine.Definition {
 	// no children yet
 	return []dslengine.Definition{}
 }
 
 // Attribute implements the Container interface of the goa Attribute
-// model
+// model.
 func (f *RelationalFieldDefinition) Attribute() *design.AttributeDefinition {
 	return f.a
-
 }
 
-// FieldDefinition returns the field's struct definition
+// FieldDefinition returns the field's struct definition.
 func (f *RelationalFieldDefinition) FieldDefinition() string {
 	var comment string
 	if f.Description != "" {
@@ -54,7 +53,7 @@ func (f *RelationalFieldDefinition) FieldDefinition() string {
 	return def
 }
 
-// Tags returns the sql and gorm struct tags for the Definition
+// Tags returns the sql and gorm struct tags for the Definition.
 func (f *RelationalFieldDefinition) Tags() string {
 	return tags(f)
 }
@@ -64,7 +63,7 @@ func (f *RelationalFieldDefinition) LowerName() string {
 	return strings.ToLower(f.FieldName)
 }
 
-// Underscore returns the field name as a lowercase string in snake case
+// Underscore returns the field name as a lowercase string in snake case.
 func (f *RelationalFieldDefinition) Underscore() string {
 	return inflect.Underscore(f.FieldName)
 }

relationalmodel.go

@@ -13,7 +13,7 @@ import (
 )
 
 // NewRelationalModelDefinition returns an initialized
-// RelationalModelDefinition
+// RelationalModelDefinition.
 func NewRelationalModelDefinition() *RelationalModelDefinition {
 	baseAttr := &design.AttributeDefinition{}
 	utd := &design.UserTypeDefinition{
@@ -48,7 +48,7 @@ func (f *RelationalModelDefinition) DSL() func() {
 	return f.DefinitionDSL
 }
 
-// TableName returns the TableName of the struct
+// TableName returns the TableName of the struct.
 func (f RelationalModelDefinition) TableName() string {
 	return inflect.Underscore(inflect.Pluralize(f.ModelName))
 }
@@ -129,7 +129,9 @@ func (f *RelationalModelDefinition) Attribute() *design.AttributeDefinition {
 
 }
 
-// Project does something interesting, and I don't remember if I use it anywhere
+// Project does something interesting, and I don't remember if I use it
+// anywhere.
+//
 // TODO find out
 func (f *RelationalModelDefinition) Project(name, v string) *design.MediaTypeDefinition {
 
@@ -217,7 +219,7 @@ func (f *RelationalModelDefinition) IterateFields(it FieldIterator) error {
 
 // PopulateFromModeledType creates fields for the model
 // based on the goa UserTypeDefinition it models, which is
-// set using BuildsFrom()
+// set using BuildsFrom().
 // This happens before fields are processed, so it's
 // ok to just assign without testing.
 func (f *RelationalModelDefinition) PopulateFromModeledType() {