Rudimentary documentation about protostan

[sakrejda]

How about this one: https://github.com/estan/protoc-gen-doc/

[ariddell]

That looks great.

I suppose we also need to write & generate documentation for the shim
functions.

On 12/28, Krzysztof Sakrejda wrote:

How about this one: https://github.com/estan/protoc-gen-doc/

---

Reply to this email directly or view it on GitHub:
#5 (comment)

[sakrejda]

Yep, I think using whatever Stan uses for those is fine (doxygen?)

[sakrejda]

Ok, close this after we:

• check to make sure we can't just use doxygen comments for documenting proto files.
• add protoc-gen-doc generator plugin as a submodule
• document current messages in protoc-gen-doc format
• add makefile logic to generate documentation for shim files
• add makefile logic to generate documentation for proto files.

[sakrejda]

Had started working on this, didn't realize I didn't claim it.

[sakrejda]

Turns out protoc-gen-doc is not straightforward to install from source so I can't just add it as a submodule and make it go. It relies on qmake to produce the makefile and the qmake project file is hard-coded to look for system libraries. I'm not going to go through incorporating it into the makefile at this point. We can follow this format for writing the documentation comments and it'll be easier to install once protobuf-3 is the mainline system protobuf (so in a few to six months (?)).