Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Option ¶
type Option func(*config)
Option is a configuration option for NewPlugin.
func WithAdditionalService ¶
WithAdditionalService registers an additional service to generate documentation for.
func WithExampleRequests ¶
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 ¶
WithSerializedDescriptors registers serialized proto descriptors to use for extracting docstrings in documentation.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.