Skip to content

[Bug] Invalid documentation on type parameter #9755

@bkoelman

Description

@bkoelman

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

  1. Create a new project and add the following class:

    /// <summary>
    /// A visitor for tree nodes.
    /// </summary>
    public sealed class NodeVisitor<T>
    {
    }
  2. Follow the getting-started steps from the docfx documentation.

  3. Open the documentation website in the browser.

    image

Expected behavior
No documentation should be shown for the type parameter, because it is not documented. This worked properly in v2.74.0:

image

Context (please complete the following information):

  • OS: Windows 11
  • Docfx version: latest master (at commit 1d5e946)
  • .NET version: .NET 8
  • docfx.json config: default settings produced by docfx init

Metadata

Metadata

Assignees

No one assigned

    Labels

    dotnetGenerate .NET API reference docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions