docgen

package

v1.1.0 Latest Latest Go to latest Published: May 7, 2023 License: BSD-2-Clause Imports: 6 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/cuberat/protoc-gen-docjson

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func GenDocData(conf *docdata.Config, file_descriptors []*desc_pb.FileDescriptorProto, ...) (*docdata.TemplateData, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var CUSTOM_OPTION_TYPES = map[string]string{
	".google.protobuf.FileOptions":      "file",
	".google.protobuf.ServiceOptions":   "service",
	".google.protobuf.MessageOptions":   "message",
	".google.protobuf.FieldOptions":     "field",
	".google.protobuf.EnumOptions":      "enum_decl",
	".google.protobuf.EnumValueOptions": "enum_val",
}

Functions ¶

func GenDocData ¶

func GenDocData(
	conf *docdata.Config,
	file_descriptors []*desc_pb.FileDescriptorProto,
	files_to_generate map[string]bool,
) (*docdata.TemplateData, error)

Types ¶

This section is empty.

Source Files ¶

View all Source files

docgen.go

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