coreos/protodoc

Name: protodoc

Owner: CoreOS

Description: protodoc generates Protocol Buffer documentation.

Created: 2016-04-18 02:28:24.0

Updated: 2018-05-20 23:06:35.0

Pushed: 2018-02-08 17:41:52.0

Homepage:

Size: 66

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

protodoc

protodoc generates Protocol Buffer documentation.

et -v -u github.com/coreos/protodoc

odoc --directory=./parse/testdata \
--parse="service,message" \
--languages="Go,C++,Java,Python" \
--title=testdata \
--output=sample.md

 combine multiple directories into one
odoc --directories=./parse/testdata=service,dirA=service_message \
--languages="Go,C++,Java,Python" \
--title=testdata \
--output=sample.md

Note that parser only understands the minimum syntax of Protocol Buffer (just enough to generate documentation).

For full featured parser, please check out https://github.com/golang/protobuf.