Fix broken javadoc HTML tags in tycho-document-bundle-plugin #5403
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.
Summary
This PR fixes malformed javadoc comments in the tycho-document-bundle-plugin that would cause javadoc generation tools to fail or produce warnings due to invalid HTML syntax.
Issues Fixed
Three javadoc syntax errors were identified and corrected:
1. Missing closing
</code>tag in JavadocMojo.java (line 125)The javadoc for the
encodingparameter was missing the closing parenthesis inside the<code>tag:2. Missing closing
</li>tag in JavadocMojo.java (line 174)The javadoc for the
mainFilenameTOC option was missing the closing list item tag:3. Incomplete javadoc comment in ConfigureMojo.java (line 24)
The class-level javadoc comment was incomplete, ending mid-sentence:
Impact
These fixes ensure that:
All changes are minimal and focused solely on correcting the javadoc syntax without affecting any code behavior.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.