search

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

Add rendering of enum constant value doc comments. #24

Closed benevans closed 10 years ago

benevans commented 10 years ago

These were being ignored by the DocletIterator.

johncarl81 commented 10 years ago

I'm trying to validate this... what enum comments are ignored specifically? Can you give me an example?

benevans commented 10 years ago

Sure:

public enum Foo {
    /** This comment gets *ignored* */
    VALUE_A,
    /** And *this* one */
    VALUE_B
}

Those comments above on the enum constant values were not being processed.

johncarl81 commented 10 years ago

Ah, I see. Whats weird is the rendered output is included in the Enum Constant Detail (bottom) but not the Enum Constant and Description (top). Thoughts?

johncarl81 commented 10 years ago

Ah, this seems to be fixed by #21

johncarl81 commented 10 years ago

@benevans, I'm looking to merge these changes in. Would you like a chance to rebase (squash / pick) this PR along with your others for a cleaner history?

benevans commented 10 years ago

Sure I'll merge the changes into one of the PRs so there's a linear sequence of changes.

benevans commented 10 years ago

Done, see PR #20.

johncarl81 commented 10 years ago

Merged in #20