protodoc

package

v1.0.5 Latest Latest Go to latest Published: Oct 28, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/manugarg/protodoc

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ArrangeIntoPackages(paths []string, l *logger.Logger) map[string][]string
func BuildFileDescRegistry(files *protoregistry.Files, protoRoot, pkgPrefix string, l *logger.Logger)
type Formatter
type Token
- func DumpMessage(md protoreflect.MessageDescriptor, f Formatter) ([]*Token, []protoreflect.FullName)
- func ProcessTokensForHTML(toks []*Token, f Formatter) []*Token

Constants ¶

This section is empty.

Variables ¶

View Source

var DocTmpl = `` /* 753-byte string literal not displayed */

View Source

var Files = &protoregistry.Files{}

Functions ¶

func ArrangeIntoPackages ¶

func ArrangeIntoPackages(paths []string, l *logger.Logger) map[string][]string

func BuildFileDescRegistry ¶

func BuildFileDescRegistry(files *protoregistry.Files, protoRoot, pkgPrefix string, l *logger.Logger)

Types ¶

type Formatter ¶

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

func (Formatter) WithDepth ¶

func (f Formatter) WithDepth(depth int) Formatter

func (Formatter) WithPrefix ¶

func (f Formatter) WithPrefix(prefix string) Formatter

func (Formatter) WithRelPath ¶ added in v1.0.1

func (f Formatter) WithRelPath(relPath string) Formatter

func (Formatter) WithYAML ¶

func (f Formatter) WithYAML(yaml bool, jsonNames bool) Formatter

type Token ¶

type Token struct {
	Prefix  string
	Suffix  template.HTML
	Comment string
	Kind    string
	Text    string
	URL     string
	Default string

	MessageHeader bool

	NoExtraLine bool

	// Filed by token processor
	TextHTML  template.HTML
	Sep       string
	ExtraLine string
	// contains filtered or unexported fields
}

func DumpMessage ¶

func DumpMessage(md protoreflect.MessageDescriptor, f Formatter) ([]*Token, []protoreflect.FullName)

func ProcessTokensForHTML ¶

func ProcessTokensForHTML(toks []*Token, f Formatter) []*Token

Source Files ¶

View all Source files

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