Add markdown-to-JavaDoc formatting conversion for documentation comments #9341
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.
TypeSpec documentation uses Markdown formatting (
**bold**,*italic*, bullet points, numbered lists) that needs to be converted to JavaDoc HTML tags for proper rendering.Changes
Added markdown conversion in
JavaJavadocComment.java**text**→<b>text</b>*text*→<i>text</i>***text***→<b><i>text</i></b>-→<ul><li>elementsN.→<ol><li>elementsImplementation approach
Known Issue
HTML tags are currently being escaped as
<and>in generated files. The conversion logic is correct (verified via standalone test), but an additional layer of escaping occurs during file writing or post-processing. Investigation shows this is likely in the protocol layer between the Java generator and TypeSpec compiler. Further debugging needed to identify and fix the escaping source.Example
Input from TypeSpec:
Expected JavaDoc output:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.