jeffhung / protoc-gen-docbook

Automatically exported from code.google.com/p/protoc-gen-docbook
https://code.google.com/p/protoc-gen-docbook/
0 stars 0 forks source link

Preserve comments line wrapping #3

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Protobuf 2.5 has added support for Javadoc comments.

This is a nice feature but nowhere as nice a your DocBook plugin.
Actually we would very much like to use both.

The standard protobuf compiler when generating the .java files will put Javadoc 
comments like this

/**
  * <pre>Here is a multi-line 
  * comment.
  * </pre>
  */
class Foo(.....) {
}

This preserves line wrapping and is actually a very good idea. I wish there was 
a way to make this plugin do the same.

Anyway, this report is not about Java, it is really just mentioned here for 
comparison.

Original issue reported on code.google.com by peterhan...@yahoo.com on 26 May 2013 at 12:11

GoogleCodeExporter commented 9 years ago
Interesting. Let me think about this. Depending on how protoc parses the 
multi-line comment, it might be easy or near impossible to do. :)

Thanks

... Alan

Original comment by askl...@gmail.com on 14 Aug 2013 at 1:45

GoogleCodeExporter commented 9 years ago
OK. Protobuf compiler is doing the right thing and is preserving the line 
breaks. I can replicate the line breaks in DocBook using the <sbr/> tag.

Should have an enhancement for this pretty shortly.

Thanks for the report. This is actually pretty useful for myself as well.

... Alan

Original comment by askl...@gmail.com on 24 Aug 2013 at 8:26

GoogleCodeExporter commented 9 years ago

Original comment by askl...@gmail.com on 24 Aug 2013 at 9:52