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

Other Useful Business Software
Paessler: Easy to Use With Enterprise Power. Free Trial Icon
Paessler: Easy to Use With Enterprise Power. Free Trial

A low-code dashboard makes monitoring intuitive for any admin, while scripting and custom sensors give experts full control.

You shouldn't have to choose between a monitoring tool that's easy to use and one that's powerful enough for a complex environment. PRTG's low-code interface lets any admin build dashboards, set alerts and monitor devices without scripting, while custom sensors and full API access are there when your team needs deeper control. One platform, no compromise. Download a free 30-day trial now.
Get Free Download
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