We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug When a generic class contains a summary, but the type parameter is not documented, the summary text is shown for the type parameter.
To Reproduce
Create a new project and add the following class:
/// <summary> /// A visitor for tree nodes. /// </summary> public sealed class NodeVisitor<T> { }
Follow the getting-started steps from the docfx documentation.
Open the documentation website in the browser.
Expected behavior No documentation should be shown for the type parameter, because it is not documented. This worked properly in v2.74.0:
Context (please complete the following information):
docfx.json
docfx init
The text was updated successfully, but these errors were encountered:
This issue seems occurred from docfx v2.75.1
It can be fixed by adding following lines to [templates/common/ManagedReference.common.js] file. (https://github.com/dotnet/docfx/blob/main/templates/common/ManagedReference.common.js#L199-L207)
if(vm.syntax.typeParameters) { vm.syntax.typeParameters.forEach(item => { item.description = item.description || ""; }); }
or explicitly assign empty string to Description property at ApiParameterBuildOutput.cs
Description
Sorry, something went wrong.
fix: Invalid documentation on type parameter #9755 (#9806)
3d95c0d
fix: Invalid documentation on type parameter dotnet#9755 (dotnet#9806)
14df1ea
e86a601
Successfully merging a pull request may close this issue.
Describe the bug
When a generic class contains a summary, but the type parameter is not documented, the summary text is shown for the type parameter.
To Reproduce
Create a new project and add the following class:
Follow the getting-started steps from the docfx documentation.
Open the documentation website in the browser.
Expected behavior
No documentation should be shown for the type parameter, because it is not documented. This worked properly in v2.74.0:
Context (please complete the following information):
docfx.json
config: default settings produced bydocfx init
The text was updated successfully, but these errors were encountered: