gendoc

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.

Documentation

Overview

Package gendoc is a truss plugin to generate markdown documentation for a protobuf definition file.

Index

• func GenerateDocs(dt deftree.Deftree) map[string]io.Reader
• func MdEnum(e *deftree.ProtoEnum, depth int) string
• func MdFile(f *deftree.ProtoFile, depth int) string
• func MdHTTPBinding(b *deftree.MethodHttpBinding, depth int) string
• func MdMessage(m *deftree.ProtoMessage, depth int) string
• func MdMethod(m *deftree.ServiceMethod, depth int) string
• func MdMicroserviceDefinition(m *deftree.MicroserviceDefinition, depth int) string
• func MdService(s *deftree.ProtoService, depth int) string

Functions

func GenerateDocs

func GenerateDocs(dt deftree.Deftree) map[string]io.Reader

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

func MdEnum

func MdEnum(e *deftree.ProtoEnum, depth int) string

func MdFile

func MdFile(f *deftree.ProtoFile, depth int) string

func MdHTTPBinding

func MdHTTPBinding(b *deftree.MethodHttpBinding, depth int) string

func MdMessage

func MdMessage(m *deftree.ProtoMessage, depth int) string

func MdMethod

func MdMethod(m *deftree.ServiceMethod, depth int) string

func MdMicroserviceDefinition

func MdMicroserviceDefinition(m *deftree.MicroserviceDefinition, depth int) string

func MdService

func MdService(s *deftree.ProtoService, depth int) string