bpdoc

package

v0.0.0-...-9c067ca Latest Latest Go to latest Published: Jun 26, 2015 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/colincross/blueprint

Links

Open Source Insights

Documentation ¶

Index ¶

func NewPackageAST(files []string) (*ast.Package, error)
func Write(filename string, pkgFiles map[string][]string, ...) error
type DocCollector
- func NewDocCollector(pkgFiles map[string][]string) *DocCollector
- func (dc *DocCollector) Docs(pkg, name string, defaults reflect.Value) (*PropertyStructDocs, error)
type PropertyDocs
type PropertyStructDocs

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewPackageAST ¶

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

func Write ¶

func Write(filename string, pkgFiles map[string][]string,
	moduleTypePropertyStructs map[string][]interface{}) error

Types ¶

type DocCollector ¶

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

func NewDocCollector ¶

func NewDocCollector(pkgFiles map[string][]string) *DocCollector

func (*DocCollector) Docs ¶

func (dc *DocCollector) Docs(pkg, name string, defaults reflect.Value) (*PropertyStructDocs, error)

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

type PropertyDocs ¶

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

func (*PropertyDocs) Clone ¶

func (docs *PropertyDocs) Clone() PropertyDocs

func (*PropertyDocs) Equal ¶

func (docs *PropertyDocs) Equal(other PropertyDocs) bool

func (*PropertyDocs) Nest ¶

func (prop *PropertyDocs) Nest(nested *PropertyStructDocs)

func (*PropertyDocs) SameSubProperties ¶

func (docs *PropertyDocs) SameSubProperties(other PropertyDocs) bool

type PropertyStructDocs ¶

type PropertyStructDocs struct {
	Name       string
	Text       string
	Properties []PropertyDocs
}

func (*PropertyStructDocs) Clone ¶

func (docs *PropertyStructDocs) Clone() *PropertyStructDocs

func (*PropertyStructDocs) ExcludeByTag ¶

func (docs *PropertyStructDocs) ExcludeByTag(key, value string)

func (*PropertyStructDocs) GetByName ¶

func (docs *PropertyStructDocs) GetByName(name string) *PropertyDocs

func (*PropertyStructDocs) IncludeByTag ¶

func (docs *PropertyStructDocs) IncludeByTag(key, value string)

func (*PropertyStructDocs) SetDefaults ¶

func (docs *PropertyStructDocs) SetDefaults(defaults reflect.Value)

Source Files ¶

View all Source files

bpdoc.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL