Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle langword for see elements #61069

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Handle langword for see elements #61069

wants to merge 1 commit into from
+80 −10

Conversation

martincostello
Copy link
Member

Handle langword for see elements

Handle <see langword="value" /> references in XML documentation as inline code.

Description

Extract the value from langword on see references and emit as inline code.

For example <see langword="true" /> becomes true.

Questions:

  1. Should it also handle seealso?
  2. Do we output verbatim, or map the keywords to something? (e.g. C# null to null but VB Nothing to null)

Fixes #61042

@martincostello
Handle langword for see elements
1c13851 
Handle `<see langword="" />` references in XML documentation as inline code.

Contributes to dotnet#61042.
@dotnet-issue-labeler dotnet-issue-labeler bot added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Mar 21, 2025
@martincostello martincostello added feature-openapi area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc and removed area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates labels Mar 21, 2025
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Mar 21, 2025
@dotnet-policy-service Dotnet Policy Service
Copy link
Contributor

Thanks for your PR, @martincostello. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@build-analysis build-analysis bot mentioned this pull request Mar 21, 2025
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@captainsafia captainsafia Awaiting requested review from captainsafia captainsafia will be requested when the pull request is marked ready for review captainsafia is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
area-minimal Includes minimal APIs, endpoint filters, parameter binding, request delegate generator etc community-contribution Indicates that the PR has been added by a community member feature-openapi
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[OpenAPI] XML source generator does not correctly escape <see> tags
1 participant
@martincostello