protodocs

package module

v0.1.5 Latest Latest Go to latest Published: Sep 19, 2023 License: MIT Imports: 14 Imported by: 2

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/curioswitch/go-docs-handler

Links

Open Source Insights

Documentation ¶

Index ¶

func NewPlugin(service string, opts ...Option) docshandler.Plugin
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewPlugin ¶

func NewPlugin(service string, opts ...Option) docshandler.Plugin

Types ¶

type Option ¶

type Option func(*config)

Option is a configuration option for NewPlugin.

func WithAdditionalService ¶

func WithAdditionalService(service string) Option

WithAdditionalService registers an additional service to generate documentation for.

func WithExampleRequests ¶

func WithExampleRequests(method string, request proto.Message, more ...proto.Message) Option

WithExampleRequests registers example requests for a method which can be selected in the debug form of the docs page. The method name should be in the format "service/method", e.g., "greet.GreetService/Greet". Connect users can use the constants for the procedures, e.g., greetconnect.GreetServiceGreetProcedure.

func WithSerializedDescriptors ¶

func WithSerializedDescriptors(serializedDescriptors []byte) Option

WithSerializedDescriptors registers serialized proto descriptors to use for extracting docstrings in documentation.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
testing

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