DOC

io.github.pseudomuto : protoc-gen-doc

Maven & Gradle

Mar 15, 2022
2.6k stars

io.github.pseudomuto: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.

Table Of Contents

Latest Version

Download io.github.pseudomuto : protoc-gen-doc Javadoc & API Documentation - Latest Versions:

All Versions

Download io.github.pseudomuto : protoc-gen-doc Javadoc & API Documentation - All Versions:

Version Size Javadoc Updated
v1.5.x
1.5.x

How to open Javadoc JAR file in web browser

  1. Rename the file protoc-gen-doc-1.5.1-javadoc.jar to protoc-gen-doc-1.5.1-javadoc.zip
  2. Use your favourite unzip tool (WinRAR / WinZIP) to extract it, now you have a folder protoc-gen-doc-1.5.1-javadoc
  3. Double click index.html will open the index page on your default web browser.

How to generate Javadoc from a source JAR?

Running the command javadoc:

javadoc --ignore-source-errors -encoding UTF-8 -sourcepath "protoc-gen-doc-1.5.1-sources.jar" -d "protoc-gen-doc-1.5.1-javadoc" -subpackages 

Advertisement