protoc gen doc

We have hosted the application protoc gen doc in order to run this application in our online workstations with Wine or directly.

Quick description about protoc gen doc:

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

Programming Language: Go.
Categories: