Skip to content

protoc-gen-doc v1.0.0

Compare
Choose a tag to compare
@pseudomuto pseudomuto released this 27 Sep 00:00
· 172 commits to master since this release
728a624

New things

  • Support for both proto2 and proto3!
  • Application is now dockerized, no need to install it (unless you want to of course)
  • Ported to Go and precompiled for Linux, OSX, and Windows
  • Added test coverage to ensure functionality and prevent regressions
  • Ignore comments starting with @exclude
  • Added (and backfilled) CHANGELOG.md
  • Added CONTRIBUTING.md

Bug fixes

  • Message enums no longer included in file enums (#288)
  • Added top-level files key for JSON output and camelCased all fields (#289)
  • Fixed issue with TOC in Markdown not nesting correctly (#293)
  • No need to worry about expiring apt keys (#295)
  • Extra slashes in comment prefix no longer show up in output (#298)
  • Added field details for templates (#300)
  • Markdown headers include new line so they render correctly (#303)

Breaking changes

  • File-level comments are now attached to the syntax directive
  • JSON fields are now camelCased
  • Mustache templates replaced with golang templates
  • Dropped direct support for PDF generation (still possible with FOP)
  • doc_out flag removed in favor of doc_opt