types

package
v0.0.0-...-dfdf79b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 15, 2024 License: Apache-2.0 Imports: 2 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Api

type Api struct {
	Title       string
	Description string
	Service     string
	Interface   string
	ObjectPath  string
	Methods     []*Method
	// those are currently avail only in health-api
	Signals    []*Method
	Properties []*Property
}

type ApiDoc

type ApiDoc struct {
	Api              *Api
	InterfaceName    string
	Package          string
	Properties       []PropertyDoc
	Methods          []MethodDoc
	Imports          string
	Constructors     []Constructor
	ExposeProperties bool
}

type ApiGroup

type ApiGroup struct {
	FileName    string
	Name        string
	Description string
	Api         []*Api
	// contains filtered or unexported fields
}

type ApiGroupDoc

type ApiGroupDoc struct {
	*ApiGroup
	Package string
}

type Arg

type Arg struct {
	Type string
	Name string
}

func (*Arg) String

func (a *Arg) String() string

type BluezError

type BluezError struct {
	Name  string
	Base  string
	Error string
}

type BluezErrors

type BluezErrors struct {
	List []BluezError
}

type Constructor

type Constructor struct {
	Service    string
	Role       string
	ObjectPath string
	Args       string
	ArgsDocs   string
	Docs       []string
}

type Flag

type Flag int
const (
	FlagReadOnly Flag = iota + 1
	FlagWriteOnly
	FlagReadWrite
	FlagExperimental
	FlagOptional
	FlagServerOnly
)

type InterfaceDoc

type InterfaceDoc struct {
	Title     string
	Name      string
	Interface string
}

type InterfacesDoc

type InterfacesDoc struct {
	Interfaces []InterfaceDoc
}

type Method

type Method struct {
	Name       string
	ReturnType string
	Args       []Arg
	Errors     []string
	Docs       string
}

func (*Method) String

func (m *Method) String() string

type MethodDoc

type MethodDoc struct {
	*Method
	ArgsList             string
	ParamsList           string
	SingleReturn         bool
	ReturnVarsDefinition string
	ReturnVarsRefs       string
	ReturnVarsList       string
}

type Property

type Property struct {
	Name  string
	Type  string
	Docs  string
	Flags []Flag
}

func (*Property) String

func (p *Property) String() string

type PropertyDoc

type PropertyDoc struct {
	*Property
	RawType            string
	RawTypeInitializer string
	ReadOnly           bool
	WriteOnly          bool
	ReadWrite          bool
}

Jump to

Keyboard shortcuts

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