doc

package
v0.1.2 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2026 License: BSD-2-Clause Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HtmlHandler added in v0.0.21

func HtmlHandler(messages []*Message, services []*Service) http.HandlerFunc

func MarkdownHandler added in v0.0.21

func MarkdownHandler(messages []*Message, services []*Service) http.HandlerFunc

Types

type Field added in v0.0.21

type Field struct {
	Name     string
	Comment  []string
	Type     string
	Required bool
	Tags     map[string]string
}

Field represents a field in a struct.

type Message added in v0.0.21

type Message struct {
	Package string
	Comment []string
	Name    string
	Fields  []Field
}

Message represents information about a data type.

type Method added in v0.0.21

type Method struct {
	Name    string
	Comment []string
	Input   *Message // Input parameter type information
	Output  *Message // Return value type information
}

Method represents a method definition in an interface.

type Service added in v0.0.21

type Service struct {
	Name    string
	Comment []string
	Package string
	Methods []Method
}

Service represents information about an interface.

Jump to

Keyboard shortcuts

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