protoc-gen-doc

command
v0.0.0-...-9c0ca05 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 13, 2018 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

protoc-gen-doc is used to generate documentation from comments in your proto files.

It is a protoc plugin, and can be invoked by passing `--doc_out` and `--doc_opt` arguments to protoc.

Example: generate HTML documentation

protoc --doc_out=. --doc_opt=html,index.html protos/*.proto

Example: use a custom template

protoc --doc_out=. --doc_opt=custom.tmpl,docs.txt protos/*.proto

For more details, check out the README at https://github.com/pseudomuto/protoc-gen-doc

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL