UNOMI-906: Fix javadoc tags and new lines.#728
Merged
sergehuber merged 2 commits intoapache:masterfrom Sep 2, 2025
Merged
Conversation
Fgerthoffert
reviewed
Sep 2, 2025
| * This class encapsulates all metadata associated with a compiled Groovy script, | ||
| * including content hash for efficient change detection and the compiled class | ||
| * for direct execution without recompilation. | ||
| * </p> |
Contributor
There was a problem hiding this comment.
Why are you removing </p> while keeping <p> ?
Aren't they never closed ?
Contributor
Author
There was a problem hiding this comment.
No, according to Javadoc Doc : https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format there is no closing tag for paragraphs:
If you have more than one paragraph in the doc comment, separate the paragraphs with a <p> paragraph tag, as shown.
Fgerthoffert
approved these changes
Sep 2, 2025
Contributor
|
Actually I have fixed that in the 2.7.x release branch and wanted to backport it to the main branch after completing the release. I solved this differently by closing the tag before the
tags. But it seems to work fine otherwise when keeping the tag. You can find my commit here, you will notice it requires a lot less changes :d06b31b |
Contributor
Author
|
Effectively, it fails because of succession of < /ul > and < /p > anyway, closing paragraph tag is useless and not allowed so removing all occurrences may be a better option ? |
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.
This PR fixes some issues that prevent javadoc generation.