protodoc generates Protocol Buffer documentation.
Branch: master
Clone or download
gyuho *: update import paths to "go.etcd.io"
Signed-off-by: Gyuho Lee <leegyuho@amazon.com>
Latest commit 484ab54 Aug 29, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
parse parse: update testdata to /v3 Feb 8, 2018
.travis.yml *: update import paths to "go.etcd.io" Aug 29, 2018
CONTRIBUTING.md initial commit Apr 18, 2016
DCO initial commit Apr 18, 2016
LICENSE
NOTICE initial commit Apr 18, 2016
README.md
code-of-conduct.md update CoC Jan 4, 2018
main.go *: update import paths to "go.etcd.io" Aug 29, 2018
sample.md
test initial commit Apr 18, 2016

README.md

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.