Back to godoc.org
go.etcd.io/protodoc

Module go.etcd.io/protodoc

v0.0.0 (484ab54)
Latest Go to latest
Published: Aug 29, 2018 | License: Apache-2.0

Source Code

README

protodoc

Build Status Godoc

protodoc generates Protocol Buffer documentation.

go get -v -u go.etcd.io/protodoc

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

# to combine multiple directories into one
protodoc --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.

Source: go.etcd.io/protodoc@v0.0.0-20180829002748-484ab544e116/README.md