Fix Javadoc in CitaviXmlImporter.java/getPages#13381
Merged
Merged
Conversation
Javadoc of CitaviXmlImporter.getPages contains invalid html, rendering it invalid javadoc. That is because some example code contains unescaped non-html `<...>` tags. Rather than escaping the problematic characters by `<`, `>`, which would have been the ugly and cheap solution, I took a moment to wrap the examples into proper snippet tags. Minor further improvements like inserting <p> tags instead of `----` which would not result in the desired effect.
|
@trag-bot didn't find any issues in the code! ✅✨ |
Siedlerchr
approved these changes
Jun 19, 2025
koppor
approved these changes
Jun 19, 2025
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
3 participants
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.
Javadoc of CitaviXmlImporter.getPages contains invalid html, rendering it invalid javadoc. That is because some example code contains unescaped non-html
<...>tags. Rather than escaping the problematic characters by<,>, which would have been the ugly and cheap solution, I took a moment to wrap the examples into proper snippet tags. Minor further improvements like inserting<p>tags instead of----which would not have resulted in the desired effect.