Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
vvalchev opened this issue Aug 31, 2015 · 1 comment
Open

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

vvalchev opened this issue Aug 31, 2015 · 1 comment

Comments

@vvalchev
Copy link

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant