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.

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

XML documention comment has incorrect remarks tag #60039

Closed
1 task done
gekka opened this issue Jan 26, 2025 · 0 comments · Fixed by #60040
Closed
1 task done

XML documention comment has incorrect remarks tag #60039

gekka opened this issue Jan 26, 2025 · 0 comments · Fixed by #60040
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates

Comments

@gekka
Copy link
Contributor

gekka commented Jan 26, 2025

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

XML documentation comments for IRazorViewEngine.FindPage has incorrent remarks tag.
However, the remarks tag has a incorrectly remarks tag.

Therefore, the generated XML file from this comment can not be correctly parsed because there is again a remarks tag within the remarks tag.

/// <remarks>
/// <remarks>Use <see cref="GetPage(string, string)"/> when the absolute or relative
/// path of the page is known.</remarks>
/// <seealso cref="IViewEngine.FindView"/>.
/// </remarks>

So, it has not been analyzed and is not shown in the Microsoft documentation site.

Expected Behavior

Delete inside tag.

/// <remarks>
/// Use <see cref="GetPage(string, string)"/> when the absolute or relative path of the page is known.
/// <seealso cref="IViewEngine.FindView"/>.
/// </remarks>

Steps To Reproduce

No response

Exceptions (if any)

No response

.NET Version

No response

Anything else?

No response

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant