Skip to content

Handle langword for see elements #61069

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
Merged
merged 3 commits into from
May 22, 2025
Merged

Handle langword for see elements #61069

merged 3 commits into from
May 22, 2025

Conversation

martincostello
Copy link
Member

@martincostello martincostello commented Mar 21, 2025 •
edited
Loading

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.

@ghost ghost 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
@build-analysis build-analysis bot mentioned this pull request Mar 21, 2025
Closed
3 tasks
martincostello
martincostello commented May 21, 2025
View reviewed changes
@martincostello
Handle langword for see elements
8861cc5 
Handle `<see langword="" />` references in XML documentation as inline code.

Resolves dotnet#61042.
@martincostello
Remove redundant using
4d14c33 
Added back by merge/rebase but not needed.
martincostello added a commit to martincostello/aspnetcore that referenced this pull request May 22, 2025
@martincostello
[OpenAPI] Only enable XML source gen for C#
88f42c1 
Only enable the OpenAPI XML source generator for C#.

See dotnet#61069 (comment).
@martincostello martincostello mentioned this pull request May 22, 2025
Merged
@martincostello martincostello marked this pull request as ready for review May 22, 2025 14:13
@martincostello martincostello requested a review from a team as a code owner May 22, 2025 14:13
captainsafia
captainsafia approved these changes May 22, 2025
View reviewed changes
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall! A few small nits to polish this up.

captainsafia pushed a commit that referenced this pull request May 22, 2025
@martincostello
[OpenAPI] Only enable XML source gen for C# (#62069)
3926315 
Only enable the OpenAPI XML source generator for C#.

See #61069 (comment).
@captainsafia captainsafia enabled auto-merge (squash) May 22, 2025 17:09
@build-analysis build-analysis bot mentioned this pull request May 22, 2025
Open
@captainsafia captainsafia merged commit 671d5d9 into dotnet:main May 22, 2025
27 checks passed
@dotnet-policy-service dotnet-policy-service bot added this to the 10.0-preview6 milestone May 22, 2025
@martincostello martincostello deleted the gh-61042 branch May 22, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@captainsafia captainsafia captainsafia approved these changes

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
10.0-preview6
Development

Successfully merging this pull request may close these issues.

[OpenAPI] XML source generator does not correctly escape <see> tags
2 participants
@martincostello @captainsafia