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

Add support for {@link …} in documentation comments #1

Open
FroMage opened this issue Sep 15, 2011 · 1 comment
Open

Add support for {@link …} in documentation comments #1

FroMage opened this issue Sep 15, 2011 · 1 comment
Labels
Milestone

Comments

@FroMage
Copy link
Owner

FroMage commented Sep 15, 2011

I want to add the following JAX-RS documentation to a REST @get method, so that I can link to
another resource method's documentation:

/**
 * The list of comments on the item, in reverse chronological order.
 * 
 * @param key The item creator’s organisation key, followed by an asterisk, followed by the 

item number.
* @http 400 Client errors are the same as for {@link #getItem(String, Request)}.
*/

However, in the HTML output this is rendered literally, instead of as a hyperlink.

jax-doclets-0.5

@FroMage
Copy link
Owner Author

FroMage commented Sep 15, 2011

It would actually be more cool to be able to say {@link GET} or {@link GET /item/{key}}

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

No branches or pull requests

2 participants