feat: Fix Java links being inside code blocks.#26
Merged
Conversation
When processing links in Java code (`{@link class#method(argType1, argType2, argType3)}`) Doxygen wraps them first in the `<computeroutput>` tag (a Doxygen semantic for `<code>` tag in Markdown) and inside in the `<ref>` tag (used for creating various links).
It leads to putting links inside code, which is not valid, those links will not be parsed, unless `linkAndInlineCodeAsHTML` config option is used (which can be also problematic in some cases).
Added a hack-tweak that when we encounter such case (a `<computeroutput>` tag with a single `<ref>` tag in it), and `linkAndInlineCodeAsHTML` option is not set, we effectively inverting them, by putting links braces over code marks (backtick).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When processing links in Java code (
{@link class#method(argType1, argType2, argType3)}) Doxygen wraps them first in the<computeroutput>tag (a Doxygen semantic for<code>tag in Markdown) and inside in the<ref>tag (used for creating various links).It leads to putting links inside code, which is not valid, those links will not be parsed, unless
linkAndInlineCodeAsHTMLconfig option is used (which can be also problematic in some cases).Added a hack-tweak that when we encounter such case (a
<computeroutput>tag with a single<ref>tag in it), andlinkAndInlineCodeAsHTMLoption is not set, we effectively inverting them, by putting links braces over code marks (backtick).