Skip to content

Honor <param> docs when a doc comment has no <summary> - #153

Open
Mpdreamz wants to merge 1 commit into
mainfrom
heed/browse/issue-74-9a2cc8
Open

Mpdreamz wants to merge 1 commit into
mainfrom
heed/browse/issue-74-9a2cc8

Conversation

@Mpdreamz

Copy link
Copy Markdown
Contributor

Closes #74

Why

Without GenerateDocumentationFile, the generator recovers the doc comment from syntax trivia. MergeMethodDocumentationFromTrivia kept the parsed result only if it had a summary, so a comment with <param> tags and no <summary> lost every short alias and description, silently.

What

Keep the trivia-parsed docs when they carry <param> docs, and only look in the trivia when the compiler gave neither a summary nor params. A generator test covers both shapes; the no-summary case fails without the fix.

Tests: generator tests (24) and integration tests (267) pass.

🤖 Generated with Claude Code

Without GenerateDocumentationFile the generator reads the doc comment from syntax trivia, but only
when the summary was empty and then discarded the result unless it had a summary. A comment with
<param> tags and no <summary> lost every alias and description.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fix A defect fixed (patch)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing <summary> tag silently drops all <param> customizations (short aliases, descriptions)

1 participant