api

Documentation

Index

• Constants
• type BaseType
• type Const
• type Enum
• type Field
• type Func
• type ImportPath
• type Module
• type Package
• type Parameter
• type Stereotype
• type Type
• type Var

Constants

const (
	StereotypeConstructor     = "constructor"
	StereotypeMethod          = "method"
	StereotypeSingleton       = "singleton"
	StereotypeEnum            = "enum"
	StereotypeEnumElement     = "enumElement"
	StereotypeDestructor      = "destructor"
	StereotypeExecutable      = "executable"
	StereotypeStruct          = "struct"
	StereotypeClass           = "class"
	StereotypeProperty        = "property"
	StereotypeParameter       = "parameter"
	StereotypeParameterIn     = "in"
	StereotypeParameterOut    = "out"
	StereotypeParameterResult = "result"
)

Types

type BaseType

type BaseType = string

type Const

type Const struct {
	Doc         string       `json:"doc,omitempty" yaml:"doc,omitempty"`
	Stereotypes []Stereotype `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
}

type Enum

type Enum struct {
	Doc string `json:"doc,omitempty" yaml:"doc,omitempty"`
}

type Field

type Field struct {
	Doc         string       `json:"doc,omitempty" yaml:"doc,omitempty"`
	BaseType    BaseType     `json:"baseType" yaml:"baseType"`
	Stereotypes []Stereotype `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
}

type Func

type Func struct {
	Doc         string                `json:"doc,omitempty" yaml:"doc,omitempty"`
	Stereotypes []Stereotype          `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
	Params      map[string]*Parameter `json:"params,omitempty" yaml:"params,omitempty"`
	Results     map[string]*Parameter `json:"results,omitempty" yaml:"results,omitempty"`
}

type ImportPath

type ImportPath = string

type Module

type Module struct {
	Readme   string                  `json:"readme,omitempty" yaml:"readme,omitempty"`
	Module   string                  `json:"module" yaml:"module"`
	Packages map[ImportPath]*Package `json:"packages,omitempty" yaml:"packages,omitempty"`
}

type Package

type Package struct {
	Readme      string            `json:"readme,omitempty" yaml:"readme,omitempty"`
	Doc         string            `json:"doc,omitempty" yaml:"doc,omitempty"`
	Name        string            `json:"name" yaml:"name"`
	Imports     []string          `json:"imports,omitempty" yaml:"imports,omitempty"`
	Stereotypes []Stereotype      `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
	Types       map[string]*Type  `json:"types,omitempty" yaml:"types,omitempty"`
	Consts      map[string]*Const `json:"consts,omitempty" yaml:"consts,omitempty"`
	Vars        map[string]*Var   `json:"vars,omitempty" yaml:"vars,omitempty"`
	Functions   map[string]*Func  `json:"functions,omitempty" yaml:"functions,omitempty"`
}

type Parameter

type Parameter struct {
	Doc         string       `json:"doc,omitempty" yaml:"doc,omitempty"`
	BaseType    BaseType     `json:"baseType" yaml:"baseType"`
	Stereotypes []Stereotype `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
}

type Stereotype

type Stereotype string

Stereotype as usually interpreted in found context but not expressed in language explicitly.

type Type

type Type struct {
	Doc         string            `json:"doc,omitempty" yaml:"doc,omitempty"`
	BaseType    BaseType          `json:"baseType" yaml:"baseType"`
	Stereotypes []Stereotype      `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
	Factories   map[string]*Func  `json:"factories,omitempty" yaml:"factories,omitempty"`
	Methods     map[string]*Func  `json:"methods,omitempty" yaml:"methods,omitempty"`
	Singletons  map[string]*Var   `json:"singletons,omitempty" yaml:"singletons,omitempty"`
	Fields      map[string]*Field `json:"fields,omitempty" yaml:"fields,omitempty"`
	Enumerals   map[string]*Enum  `json:"enum,omitempty" yaml:"enum,omitempty"`
}

type Var

type Var struct {
	Doc         string       `json:"doc,omitempty" yaml:"doc,omitempty"`
	Stereotypes []Stereotype `json:"stereotypes,omitempty" yaml:"stereotypes,omitempty"`
}