bpdoc

Documentation

Index

• func NewPackageAST(files []string) (*ast.Package, error)
• type Context
  • func NewContext(pkgFiles map[string][]string) *Context
  • func (c *Context) PropertyStruct(pkgPath, name string, defaults reflect.Value) (*PropertyStruct, error)
• type ModuleType
  • func ModuleTypes(pkgFiles map[string][]string, ...) ([]*ModuleType, error)
• type Property
  • func (p *Property) Clone() Property
  • func (p *Property) Equal(other Property) bool
  • func (p *Property) Nest(nested *PropertyStruct)
  • func (p *Property) SameSubProperties(other Property) bool
• type PropertyStruct
  • func (ps *PropertyStruct) Clone() *PropertyStruct
  • func (ps *PropertyStruct) ExcludeByTag(key, value string)
  • func (ps *PropertyStruct) GetByName(name string) *Property
  • func (ps *PropertyStruct) IncludeByTag(key, value string)
  • func (ps *PropertyStruct) SetDefaults(defaults reflect.Value)

Functions

func NewPackageAST

func NewPackageAST(files []string) (*ast.Package, error)

Types

type Context

type Context struct {
	// contains filtered or unexported fields
}

func NewContext

func NewContext(pkgFiles map[string][]string) *Context

func (*Context) PropertyStruct

func (c *Context) PropertyStruct(pkgPath, name string, defaults reflect.Value) (*PropertyStruct, error)

Return the PropertyStruct associated with a property struct type. The type should be in the format <package path>.<type name>

type ModuleType

type ModuleType struct {
	// Name is the string that will appear in Blueprints files when defining a new module of
	// this type.
	Name string

	// Text is the contents of the comment documenting the module type
	Text string

	// PropertyStructs is a list of PropertyStruct objects that contain information about each
	// property struct that is used by the module type, containing all properties that are valid
	// for the module type.
	PropertyStructs []*PropertyStruct
}

ModuleType contains the info about a module type that is relevant to generating documentation.

func ModuleTypes

func ModuleTypes(pkgFiles map[string][]string, moduleTypePropertyStructs map[string][]interface{}) ([]*ModuleType, error)

type Property

type Property struct {
	Name       string
	OtherNames []string
	Type       string
	Tag        reflect.StructTag
	Text       template.HTML
	OtherTexts []template.HTML
	Properties []Property
	Default    string
}

func (*Property) Clone

func (p *Property) Clone() Property

func (*Property) Equal

func (p *Property) Equal(other Property) bool

func (*Property) Nest

func (p *Property) Nest(nested *PropertyStruct)

func (*Property) SameSubProperties

func (p *Property) SameSubProperties(other Property) bool

type PropertyStruct

type PropertyStruct struct {
	Name       string
	Text       string
	Properties []Property
}

func (*PropertyStruct) Clone

func (ps *PropertyStruct) Clone() *PropertyStruct

func (*PropertyStruct) ExcludeByTag

func (ps *PropertyStruct) ExcludeByTag(key, value string)

func (*PropertyStruct) GetByName

func (ps *PropertyStruct) GetByName(name string) *Property

func (*PropertyStruct) IncludeByTag

func (ps *PropertyStruct) IncludeByTag(key, value string)

func (*PropertyStruct) SetDefaults

func (ps *PropertyStruct) SetDefaults(defaults reflect.Value)