← All repos

protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers

documentation-toolgogolanghacktoberfesthacktoberfest2021protobufprotoc
Browse cluster: Protocol Buffers & gRPC Ecosystem
493commits
39contributors
5languages

Tech stack & purpose

protoc-gen-doc is a documentation generator plugin for Google Protocol Buffers that extracts comments from `.proto` files and generates documentation in multiple formats including HTML, JSON, DocBook, and Markdown. The tool supports both proto2 and proto3 syntax and is built in Go, with distribution available via Go modules, Docker images, Maven Central, and pre-built binaries for various platforms. It integrates with the protoc compiler through command-line options and supports custom Go templates for documentation output, as well as features like excluding specific comments and generating camel-case field names.

Languages

Go
73.9%
Go Template
21.9%
Makefile
3.6%
Shell
0.4%
Dockerfile
0.3%

Contributors (top 30 of 39)