Skip to content

feat(doc extractor): support for cref, paramref and langword xml doc elements#95

Merged
aneojgurhem merged 2 commits into
mainfrom
jf/cref
Apr 24, 2026
Merged

feat(doc extractor): support for cref, paramref and langword xml doc elements#95
aneojgurhem merged 2 commits into
mainfrom
jf/cref

Conversation

@jfonseca-aneo
Copy link
Copy Markdown
Contributor

@jfonseca-aneo jfonseca-aneo commented Apr 23, 2026

Motivation

C# XML documentation commonly references other types and members using , parameters
using , and language keywords using . These are first-class
constructs in the doc comment syntax, but the extractor was treating them as unknown nodes and silently
dropping their content which might leave gaps in the generated markdown.

Summary

This PR introduces the following changes:

  • Add handling for XmlEmptyElementSyntax nodes in RenderXmlNodes, which Roslyn produces for
    self-closing XML doc tags — previously silently ignored
  • Render and as inline code using the referenced symbol name
  • Render as inline code (e.g. null, true)
  • Render and as inline code
  • Handle the non-self-closing form display text, preferring the explicit display
    text over the cref

@jfonseca-aneo jfonseca-aneo changed the title feat: support render cref, paramref and langword xml doc elements in markdown doc feat(doc extractor): support render cref, paramref and langword xml doc elements Apr 23, 2026
@jfonseca-aneo jfonseca-aneo changed the title feat(doc extractor): support render cref, paramref and langword xml doc elements feat(doc extractor): support for cref, paramref and langword xml doc elements Apr 23, 2026
@aneojgurhem aneojgurhem merged commit b9e6df7 into main Apr 24, 2026
17 checks passed
@aneojgurhem aneojgurhem deleted the jf/cref branch April 24, 2026 12:31
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