search

sdaschner / jaxrs-analyzer

Creates REST documentation for JAX-RS projects
Apache License 2.0
319 stars 101 forks source link

Support for @response javadoc tag hint #130

Closed rmpestano closed 6 years ago

rmpestano commented 6 years ago

refs #129

sdaschner commented 6 years ago

Unfortunately the JavaDoc enhancements broke your PR... I had to touch a lot of locations of the JavaDoc parsing. Could you please check again?

rmpestano commented 6 years ago

Hi @sdaschner,

I think it is now compatible with the new Javadoc enhancements.

The only problem is that class level @response javadoc tag is not working, only resource level.

Mainly because class level Javadoc is not being collected and then it is always empty here

I did not changed that because I did not feel I was doing the right thing ;)

Would you look at why (or how to make) class level Javadoc tags not being collected?

I'm using the same example of issue #129 to test it.

sdaschner commented 6 years ago

Cool, thanks! I'll have a look at it. The class level JavaDoc were not collected so far since there wasn't any use of it (no @param at that level). The getFieldComments() actually refers to fields of the class (i.e. when a class defines @QueryParam String query; fields). But your suggestion to enhance it makes sense.

sdaschner commented 6 years ago

Merged. I refactored the model a bit. I think this fits the idea better.

It would be awesome if you could add a few scenarios to the systemtest repo: https://github.com/sdaschner/jaxrs-analyzer-st

rmpestano commented 6 years ago

Yes, I'll do that. Thank you.