This is a documentation generator plugin for the Google Protocol Buffers compiler (protoc). The plugin can generate HTML, JSON, DocBook, and Markdown documentation from comments in your .proto files. There is a Docker image available (docker pull pseudomuto/protoc-gen-doc) that has everything you need to generate documentation from your protos. The plugin is invoked by passing the --doc_out, and --doc_opt options to the protoc compiler. The docker image has two volumes: /out and /protos which are the directory to write the documentation to and the directory containing your proto files. By default HTML documentation is generated in /out/index.html for all .proto files in the /protos volume. This can be changed by passing the --doc_opt parameter to the container.

Features

  • Generates markdown documentation for message and service definitions in .proto files
  • Support for custom templates to control the output format
  • Support for generating documentation for multiple languages (e.g. Go, Java, C++, etc.)
  • Support for outputting to various file formats (e.g. markdown, HTML, etc.)
  • Support for including examples
  • Support for documenting extensions

Project Samples

Project Activity

See All Activity >

Categories

Documentation

License

MIT License

Follow protoc-gen-doc

protoc-gen-doc Web Site

You Might Also Like
Top-Rated Free CRM Software Icon
Top-Rated Free CRM Software

216,000+ customers in over 135 countries grow their businesses with HubSpot

HubSpot is an AI-powered customer platform with all the software, integrations, and resources you need to connect your marketing, sales, and customer service. HubSpot's connected platform enables you to grow your business faster by focusing on what matters most: your customers.
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of protoc-gen-doc!

Additional Project Details

Operating Systems

Linux, Mac, Windows

Programming Language

Go

Related Categories

Go Documentation Software

Registered

2023-01-23