the doclet doesn't support {@link}, {@see} .. etc.

teamcarma / swagger-jaxrs-doclet

This fork is no longer actively maintained, please switch to https://github.com/conorroche/swagger-doclet

Apache License 2.0

81 stars 38 forks source link

the doclet doesn't support {@link}, {@see} .. etc. #106

Open vvalchev opened 9 years ago

vvalchev commented 9 years ago

When the javadoc contains tags, like the one above, the generated description contains something like

Retrieves the representation of the {@link M2MResource} which holds a

I've tracked the problem to ParserHelper.getInheritableCommentText(), which uses methodDoc.commentText(). The documentation of that method actually says, that tags like {@link} will be removed, but that's not true.

Instead the method should be modified to use methodDoc.inlineTags() and convert the tags to string.

vvalchev commented 9 years ago

I have a working patch for the problem that

modifies ClassDocCache to support java7 syntax (this is only java 8 syntax you use in the code, and build infrastructure in companies usually doesn't have the latest stuff installed)
ParserHelper.getInheritableCommentText() calls a new helper to process the tags
adds TagHelper.java
adds extlink.properties - it contains package-to-external-link mapping.

Since there is no way to upload the patch here, I've uploaded it here: http://valio.xaxo.org/files/commit-27a8389.zip

Regards, Valentin