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	Removing newline characters which were breaking linting	2025-03-03 14:29:49 +05:30
scripts	Ensure all files are covered by go fmt	2025-02-28 14:12:51 -08:00
CONTRIBUTING.md	initial commit	2016-04-17 19:30:06 -07:00
DCO	initial commit	2016-04-17 19:30:06 -07:00
LICENSE	initial commit	2016-04-17 19:30:06 -07:00
Makefile	Add a Makefile as interface to run tests	2025-02-28 14:12:51 -08:00
NOTICE	initial commit	2016-04-17 19:30:06 -07:00
OWNERS	Add OWNERS file for protodoc.	2023-10-03 22:20:33 +13:00
README.md	*: update import paths to "go.etcd.io"	2018-08-28 17:27:48 -07:00
code-of-conduct.md	update CoC	2018-01-04 12:31:37 -08:00
go.mod	Bump Go to 1.24.7	2025-09-28 14:33:58 +08:00
go.sum	Add go.mod	2025-02-28 11:09:48 -08:00
main.go	Removing newline characters which were breaking linting	2025-03-03 14:29:49 +05:30
sample.md	*: add disclaimer	2016-06-16 11:32:24 -07:00

README.md

protodoc

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.