Back to godoc.org
go.etcd.io/protodoc

Command protodoc

v0.0.0 (484ab54)
Latest Go to latest
Published: Aug 29, 2018 | License: Apache-2.0 | Module: go.etcd.io/protodoc

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
Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier