Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 30, 2025

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 encoding parameter was missing the closing parenthesis inside the <code> tag:

// Before:
* <li><code>encoding</code>, used as javadoc <code>-encoding</code> parameter (default:
* <code>${project.build.sourceEncoding}</code></li>

// After:
* <li><code>encoding</code>, used as javadoc <code>-encoding</code> parameter (default:
* <code>${project.build.sourceEncoding}</code>)</li>

2. Missing closing </li> tag in JavadocMojo.java (line 174)

The javadoc for the mainFilename TOC option was missing the closing list item tag:

// Before:
* <li><code>mainFilename</code>, specifies the filename of the TOC file (default:
* "overview-summary.html")

// After:
* <li><code>mainFilename</code>, specifies the filename of the TOC file (default:
* "overview-summary.html")</li>

3. Incomplete javadoc comment in ConfigureMojo.java (line 24)

The class-level javadoc comment was incomplete, ending mid-sentence:

// Before:
/**
 * This mojo is only there
 */

// After:
/**
 * This mojo is only there to provide configuration parameters and should not be executed directly.
 */

Impact

These fixes ensure that:

  • Javadoc generation tools can properly parse the documentation without errors
  • HTML rendering of the javadoc is correct with properly matched tags
  • The documentation is complete and meaningful for developers

All changes are minimal and focused solely on correcting the javadoc syntax without affecting any code behavior.

Original prompt

Fix broken javadoc


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI changed the title [WIP] Fix broken javadoc Fix broken javadoc HTML tags in tycho-document-bundle-plugin Sep 30, 2025
Copilot AI requested a review from laeubi September 30, 2025 11:49
Copilot finished work on behalf of laeubi September 30, 2025 11:49
@laeubi laeubi marked this pull request as ready for review September 30, 2025 11:58
@laeubi laeubi force-pushed the copilot/fix-6bc8e1da-38f7-4807-96fa-317057e8972e branch from 3e24e40 to 3c6ca52 Compare October 9, 2025 15:43
@laeubi
Copy link
Member

laeubi commented Oct 9, 2025

@waynebeaton as discussed in the EAC meeting this is the first item (and most likely an easy one), so I would say it falls in "Category A" not a problem and simply overrule the ECA check?

@github-actions
Copy link

github-actions bot commented Oct 9, 2025

Test Results

1 014 files  1 014 suites   6h 17m 39s ⏱️
1 297 tests 1 277 ✅ 20 💤 0 ❌
3 891 runs  3 828 ✅ 63 💤 0 ❌

Results for commit 3c6ca52.

@laeubi laeubi merged commit 8fd07f8 into main Oct 20, 2025
13 of 15 checks passed
@laeubi laeubi deleted the copilot/fix-6bc8e1da-38f7-4807-96fa-317057e8972e branch October 20, 2025 12:25
laeubi added a commit to laeubi/tycho that referenced this pull request Oct 20, 2025
laeubi added a commit that referenced this pull request Oct 20, 2025
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: laeubi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants