TL;DR

Protocol Buffers のコンパイラ protoc のプラグインで、.proto ファイルに書いたコメントからドキュメントを生成する。proto2 と proto3 の両方に対応している。

仕組み

出力形式として HTML、Markdown、DocBook、JSON が組み込まれている。Go のテンプレートファイルを渡せば、独自の形式でも出力できる。

protoc を実行するときに、出力先を --doc_out で、形式と出力ファイル名を --doc_opt で指定する。--doc_opt は <形式>|<テンプレートファイル>,<出力ファイル名> の形で書く。

例

proto/ 以下のすべての .proto ファイルから、doc/index.html を生成する。

protoc --doc_out=./doc --doc_opt=html,index.html proto/*.proto

関連

出典