Search Terms

@link parser should allow https:// links to appear with link text, even if words in the text match with e.g. class names in the codebase.

Problem

In my comment-based documentation I have links like {@link https://en.wikipedia.org/wiki/Immutable_object | Immutable Objects}.

Unfortunately this markdown appears like Objects and it links to an Immutable type that exists in my repo, rather than using the Wikipedia link and providing the link text Immutable Objects as expected. Omitting crucial words changes the fundamental meaning of sentences in the documentation.

 * Flagging all state references as {@link Immutable} guides IDEs to treat these
 * as {@link https://en.wikipedia.org/wiki/Immutable_object | Immutable Objects}
 * to avoid programming errors.

Suggested Solution

The presence of the URL should prevent further words from being interpreted as references to internal types.