README

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.

Expand ▾ Collapse ▴

Documentation

Overview

protodoc generates Protocol Buffer documentation.

Usage:
protodoc [flags]

Flags:
	--directories=: comma separated map of target directory to parse options (e.g. 'dirA=message,dirB=message_service')
-d, --directory="": target directory where Protocol Buffer files are.
-c, --disclaimer="": disclaimer statement
-h, --help[=false]: help for protodoc
-l, --languages=[]: language options in field descriptions (Go, C++, Java, Python, Ruby, C#)
	--message-only-from-this-file="": if specified, it parses only the messages in this file within the directory
-o, --output="": output file path to save documentation
-p, --parse=[service,message]: Protocol Buffer types to parse (message, service)
-t, --title="": title of documentation

Source Files

Directories

Path Synopsis
parse Package parse parses Protocol Buffers.