[protobuf] Re: Thinking of implementing: extract documentation in .proto file and store in FileDescriptorProto

2009-12-22 Thread Christopher Piggott
> > > Is this a constraint we want to have or need > > I think so.  I think it's helpful to say "This comment is special." > I disagree. OK, I concede. I tried to think of a good reason why I would have a comment in the .proto but NOT want to have it in the generated code - and I couldn't really

Re: [protobuf] Re: Thinking of implementing: extract documentation in .proto file and store in FileDescriptorProto

2009-12-22 Thread Henner Zeller
Hi, On Tue, Dec 22, 2009 at 15:00, Christopher Piggott wrote: > > > On Dec 22, 4:53 pm, Henner Zeller > wrote: >>   /* >>    * some block comment >>    */ >>   int32 some_field = 1; >>   int32 some_other_field = 2;  // short comment. > > I would be fine with that, but I also woudn't have a proble

Re: [protobuf] Re: Thinking of implementing: extract documentation in .proto file and store in FileDescriptorProto

2009-12-22 Thread Kenton Varda
On Tue, Dec 22, 2009 at 3:00 PM, Christopher Piggott wrote: > > Is this a constraint we want to have or need > > I think so. I think it's helpful to say "This comment is special." I disagree. There are two cases: 1) The developer had the doc generator in mind when he wrote the file. In this

[protobuf] Re: Thinking of implementing: extract documentation in .proto file and store in FileDescriptorProto

2009-12-22 Thread Christopher Piggott
> > But more difficult is comments like this: > >   // Blah blah blah here is a list: > >   // * blah blah blah > >   // * blah blah blah blah > >   // * blah blah Hmm. Javadoc would let you encode lists as ... ... which would be nice, though I suppose not critical. Seems that you could just

[protobuf] Re: Thinking of implementing: extract documentation in .proto file and store in FileDescriptorProto

2009-12-22 Thread Christopher Piggott
On Dec 22, 4:53 pm, Henner Zeller wrote: >   /* >    * some block comment >    */ >   int32 some_field = 1; >   int32 some_other_field = 2;  // short comment. I would be fine with that, but I also woudn't have a problem with you requiring everything be a block, because you can still do it on on