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

Fix invalid @see tag references in KiwiUrls #613

Closed
sleberknight opened this issue Oct 20, 2021 · 0 comments · Fixed by #614
Closed

Fix invalid @see tag references in KiwiUrls #613

sleberknight opened this issue Oct 20, 2021 · 0 comments · Fixed by #614
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@sleberknight
Copy link
Member

Problem

You can't do this:

@see #queryStringToMap(String) for inverse

The rendered Javadoc just contains "for inverse" as a link.

How to fix:

For queryStringToMap:

@see #toQueryString(Map) toQueryString(Map) for the inverse operation

For toQueryString:

@see #queryStringToMap(String) queryStringToMap(String) for the inverse operation

I hate having to repeat the method signature, but that's on javadoc, not me. 👿

@sleberknight sleberknight added the documentation Improvements or additions to documentation label Oct 20, 2021
@sleberknight sleberknight added this to the 1.1.0 milestone Oct 20, 2021
@sleberknight sleberknight self-assigned this Oct 20, 2021
sleberknight added a commit that referenced this issue Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant