etcd-io
/
protodoc
mirror of https://github.com/etcd-io/protodoc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
protodoc generates Protocol Buffer documentation.
47 Commits 1 Branch 0 Tags 136 KiB
Go 97.8%
Shell 2%
Makefile 0.2%
Go to file
Ivan Valdes 19646e4e9b
Ensure all files are covered by go fmt 
The current approach was only running go fmt on the top-level *.go
files.

Signed-off-by: Ivan Valdes <ivan@vald.es>
 		2025-02-28 14:12:51 -08:00
parse parse: update testdata to /v3 2018-02-07 21:27:50 -05:00
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
main.go *: update import paths to "go.etcd.io" 2018-08-28 17:27:48 -07:00
sample.md *: add disclaimer 2016-06-16 11:32:24 -07:00

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.