Hi all,
Just like the topic says, I've written a plugin for protoc that generates
Markdown / HTML / DocBook from comments in your .proto files. The plugin is
available here:
https://github.com/estan/protoc-gen-doc
The plugin makes use of Mustache templates to generate its output, which
means that in addition to the built-in formats, you can write your own
quite easily. Apart from that, the functionality is quite simple, but good
enough for my needs. The plugin respects /** */ and /// documentation
comments for messages, fields, enums and enum values. See the GitHub repo
for an example of what the output looks like.
So please, start documenting your .proto files and send me some feedback /
bug reports / patches! :)
Best regards,
Elvis Stansvik
PS. I know about protoc-gen-docbook, but it's a) Linux-unfriendly and b)
DocBook only, while I was primarily looking for Markdown. DS.
--
You received this message because you are subscribed to the Google Groups
"Protocol Buffers" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/protobuf.
For more options, visit https://groups.google.com/d/optout.
