protoc-gen-doc

Windows · Mac · Linux · Self-hosted

Freedom report

Two barsScore 5.5

protoc-gen-doc is ranked #15 of 23 in gRPC tools on Freedom251. It runs on Linux, macOS, Self-hosted, Windows.

Compared on gRPC tools

Purpose: protoc-gen-doc is a documentation generator plugin for the Google Protocol Buffers compiler.
Output formats: It generates HTML, JSON, DocBook, and Markdown documentation from comments in .proto files.
Proto support: It supports proto2 and proto3, including both in the same context.
Installation: The project offers a Docker image, Go installation, prebuilt releases, and a Maven Central package.
Customization: Users can supply a custom Go template and can customize HTML output with a stylesheet.css file.
Documentable elements: Comments can document files, messages, fields, services and methods, enums and values, and extensions.
Filtering: The plugin supports excluding files by path patterns and excluding comments with the @exclude prefix.
License: The software is distributed under the MIT License, which permits use, copying, modification, distribution, sublicensing, and sale subject to its terms.
Security: The repository says it has no SECURITY.md security policy and no published security advisories.
Release signature: The v1.5.1 release page says its tag was signed with the committer’s verified signature.
Output path option: The source_relative flag writes generated output in the same relative directory as the input file.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.