package
0.1.0
Repository: https://github.com/unity-technologies/truss.git
Documentation: pkg.go.dev

# README

NOTE: Unused.

Hopefully in the future we can use something like swagger to generate docs

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_bindings directive when declaring http options causes the parser to break.

# Functions

GenerateDocs accepts a deftree that represents an ast of a group of protofiles and returns map[string]io.Reader that represents a relative filestructure of generated docs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author