protodoc generates Protocol Buffer documentation.
Go to file
Iván Valdés Castillo f983ffb46d
Merge pull request #24 from hwdef/bump-go1247
Bump Go to 1.24.7
2025-09-29 23:56:52 +00:00
parse
scripts
CONTRIBUTING.md
DCO
LICENSE
Makefile
NOTICE
OWNERS
README.md
code-of-conduct.md
go.mod
go.sum
main.go
sample.md

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.