README
¶
gendocs
A truss plugin which can generate documentation from an annotated Protobuf definition file. Handles http-options.
Limitations and Bugs
Currently, there are a variety of limitations in the documentation parser.
- Having additional http bindings via the
additional_bindingsdirective when declaring http options causes the parser to break.
Documentation
¶
Overview ¶
Package gendoc is a truss plugin to generate markdown documentation for a protobuf definition file.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateDocs ¶
func GenerateDocs(dt doctree.Doctree) []truss.NamedReadWriter
GenerateDocs accepts a doctree that represents an ast of a group of protofiles and returns a []truss.SimpleFile that represents a relative filestructure of generated docs
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Doctree, which stands for "documentation tree", creates a tree of nodes representing the components of a service defined through Protobuf definition files.
|
Doctree, which stands for "documentation tree", creates a tree of nodes representing the components of a service defined through Protobuf definition files. |
|
makedt
Makedt is a package for exposing the creation of a doctree structure.
|
Makedt is a package for exposing the creation of a doctree structure. |
|
makedt/googlethirdparty
Package google_api is a generated protocol buffer package.
|
Package google_api is a generated protocol buffer package. |
|
Svcparse, which stands for "service parser" will parse the 'service' declarations within a provided protobuf and associate comments within that file with the various components of the service.
|
Svcparse, which stands for "service parser" will parse the 'service' declarations within a provided protobuf and associate comments within that file with the various components of the service. |
Click to show internal directories.
Click to hide internal directories.