Fix #21, incorrect javadoc summary lines

asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.

https://github.com/asciidoctor/asciidoclet

Apache License 2.0

133 stars 40 forks source link

Fix #21, incorrect javadoc summary lines #23

Closed benevans closed 10 years ago

benevans commented 10 years ago

Use simpler section & paragraph output templates so javadoc can correctly extract the first sentence for its package, class & method summaries.
Templates are bundled as resources in asciidoclet.jar then written to a tmp dir on javadoc execution where Asciidoctor can find them.
Added Guava dependency to simplify copying of resources.

johncarl81 commented 10 years ago

@benevans, Looks great. My only reservation is adding Guava is a lot for just simplified file management. What do you think about repackaging using the shade or jarjar plugin?

benevans commented 10 years ago

I'm not sure needed, with most people (hopefully by now!) using a dependency manager of some sort. There's already the asciidoctor-java-integration dependency, does adding another one make much of a difference? But I can do that if you'd prefer.

Either way it's still useful to have Guava there as a dependency, I use it a bit more in some later patches on my branch, it just avoids a lot of duplicated code for those basic things like copying files etc.

johncarl81 commented 10 years ago

Totally agree, and I guess a javadoc dependency really shouldn't collide with any other dependencies.

benevans commented 10 years ago

Merged into PR #20.

johncarl81 commented 10 years ago

Merged in #20