[protobuf] Re: generating proto documentation

2013-06-04 Thread Justin Esplin
I realize this thread had been dead for several years, but I'm wondering if there is a good link somewhere to your perl script? I need to generate documentation for proto files and had decided that was probably the best approach. If there were a plugin for Visual Studio that would be fine too

Re: generating proto documentation

2009-05-07 Thread OJW
I've put up the perl script we use to generate documentation of proto files: http://dev.openstreetmap.org/~ojw/proto2wikidoc Our proto files are in quite a simplified format, so this probably won't parse your files without modification. However, it's a base to start from if anyone wants to add

Re: generating proto documentation

2009-03-17 Thread bart van deenen
Hi all I'm answering myself here. I have a useful first step solution; a Python script that mogrifies the proto files into a pile of C structs that can be handled by doxygen. The python stuff is at http://github.com/bvdeenen/proto2c/tree/master an can be used proto2c.py > Then process th

Re: generating proto documentation

2009-03-17 Thread bart van deenen
Hi all I've set up an initial repos here : http://github.com/bvdeenen/proto2c/tree/master It's one python script that you can run with one .proto file as a command line argument. It generates valid c (except for messages with nested enum definitions), which you can process with doxygen. Its jus

Re: generating proto documentation

2009-03-17 Thread bart van deenen
I'm thinking of writing some scripting stuff, convert 'message' to 'struct' and stuff like that, and see how far I'll get with converting proto files into some sort of pseudo-c. I think I'll mogrify the 'optional' and 'required' and 'repeated' flags to some custom doxygen tags. As soon as I have s

Re: generating proto documentation

2009-03-17 Thread Mark Assad
HI, I have a bad solution. What I've been doing has been generating the .cc/.h files, and then using doxygen to document those classes. You can document C++ classes from files other than the header files that define the classes. It's messy, error prone, and you end up with a lot of extra methods

generating proto documentation

2009-03-17 Thread bart van deenen
Hi all How do you document .proto files? I'd love to really define our protocol with javadoc/qtdoc/doxygen tags inside the .proto files, and generate html documentation from that. Does anyone already have a solution, or something in the works that we can improve on? --~--~-~--~~-