Skip to content

Fix S2094 FP: Documentation using the DefaultDocumentation package #9062

@denis-troller

Description

@denis-troller

Description

Rule S2094 should not raise when used to document assembly and namespaces with package DefaultDocumentation

Repro steps

According to the packages documentation, you can document your assembly like this:

namespace YourAssemblyName
{
    /// <summary>
    /// your assembly documentation, used on the assembly page
    /// </summary>
    internal static class AssemblyDoc { } // internal so it is not visible outside the assembly
}

And you can document your namespace like this:

namespace YourNamespace
{
    /// <summary>
    /// your namespace documentation
    /// </summary>
    internal static class NamespaceDoc { } // internal so it is not visible outside the assembly
}

Expected behavior

I expect rule S2094 not to raise in such cases..

Actual behavior

Rule S2094 raises an issue.

Metadata

Metadata

Assignees

Labels

False PositiveRule IS triggered when it shouldn't be.

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions