Skip to content

protodoc generates Protocol Buffer documentation.

License

Notifications You must be signed in to change notification settings

etcd-io/protodoc

Folders and files

NameName
Last commit message
Last commit date
Mar 3, 2025
Feb 28, 2025
Apr 18, 2016
Apr 18, 2016
Apr 18, 2016
Feb 28, 2025
Apr 18, 2016
Oct 3, 2023
Aug 29, 2018
Jan 4, 2018
Mar 9, 2025
Feb 28, 2025
Mar 3, 2025
Jun 16, 2016

Repository files navigation

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.

About

protodoc generates Protocol Buffer documentation.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published