jaxrs-analyzer icon indicating copy to clipboard operation
jaxrs-analyzer copied to clipboard

param annotation text is not present in asciidoc

Open tbee opened this issue 7 years ago • 6 comments

The descriptive text for parameters is present in the swagger output, so it is harvested, but it is not in the asciidoc file. I'd figure that would be very relevant information to include in documentation.

tbee avatar Sep 15 '17 13:09 tbee

Hey tbee, can you tell me if you manage to get swagger annotations (or javadocs) working on 0.15?

jmanteigueiro avatar Sep 17 '17 18:09 jmanteigueiro

Hm, I just let it generate the default stuff; I wanted the asciidoc generated PDF and noticed the missing param text. So I have not tried any additional swagger annotations.

tbee avatar Sep 18 '17 06:09 tbee

The JAX-RS Analyzer doesn't support Swagger annotations.

Yes, maybe the JavaDoc information is not yet in all Backends. If you would like to, I'd highly appreciate contributions and PRs :-)

sdaschner avatar Sep 21 '17 14:09 sdaschner

I understand, I have the same sentiment when people ask me to make changes to JFXtras. But it is much harder for them to work them into the code than it is for me. (And it is for you here ;-) ) But maybe I'll find time somewhere between that and I the talk I'm prepping for JavaOne.

tbee avatar Sep 21 '17 16:09 tbee

I think you are hijacking my issue here and should start a new ones with the requests and suggestions.

tbee avatar Sep 26 '17 09:09 tbee

I just updated the JavaDoc support. Now it should be easier to enhance the gathered information.

Leaving this issues open for now...

Yes, @jmanteigueiro please open new issues and refrain from hijacking :-)

sdaschner avatar Nov 18 '17 20:11 sdaschner