docgen

package
v0.0.0-...-a66c66c Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2025 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Process

func Process(packagePath string) error

Types

type Argument

type Argument struct {
	Index   int    `xml:"index,attr"`
	Name    string `xml:"name,attr"`
	Type    string `xml:"type,attr"`
	Default string `xml:"default,attr"`
}

type Class

type Class struct {
	XMLName xml.Name `xml:"class"`

	Name     string `xml:"name,attr"`
	Inherits string `xml:"inherits,attr"`
	Version  string `xml:"version,attr"`

	BriefDescription string     `xml:"brief_description"`
	Description      string     `xml:"description"`
	Tutorials        []Link     `xml:"tutorials>link"`
	Methods          []Method   `xml:"methods>method"`
	Members          []Member   `xml:"members>member"`
	Signals          []Signal   `xml:"signals>signal"`
	Constants        []Constant `xml:"constants>constant"`
}

type Constant

type Constant struct {
	Name        string `xml:"name,attr"`
	Value       string `xml:"value,attr"`
	Enum        string `xml:"enum,attr"`
	Description string `xml:",chardata"`
}
type Link struct {
	Title string `xml:"title,attr"`
	Value string `xml:",chardata"`
}

type Member

type Member struct {
	Name        string `xml:"name,attr"`
	Type        string `xml:"type,attr"`
	Setter      string `xml:"setter,attr"`
	Getter      string `xml:"getter,attr"`
	Description string `xml:",chardata"`
}

type Method

type Method struct {
	Name        string     `xml:"name,attr"`
	Return      Return     `xml:"return"`
	Arguments   []Argument `xml:"param"`
	Description string     `xml:"description"`
}

type Return

type Return struct {
	Type string `xml:"type,attr"`
}

type Signal

type Signal struct {
	Name        string     `xml:"name,attr"`
	Param       []Argument `xml:"param"`
	Description string     `xml:"description"`
}

type XML

type XML []Class

Jump to

Keyboard shortcuts

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