Visual Studio 2015 14.0.25422.01 Update 3
StyleCopAnalyzers 1.0.0
Silverlight 5 project (but most probably an issue in other projects as well)
Output XML documentation enabled
Steps to reproduce:
PersonFirstName.cs
/// <summary>
/// A person
/// </summary>
/// <typeparam name="T">The type</typeparam>
public partial class Person<T>
{
/// <summary>
/// Gets or sets the first name.
/// </summary>
/// <value>
/// The first name.
/// </value>
public string FirstName { get; set; }
}
PersonLastName.cs
/// <summary>
/// A person
/// </summary>
public partial class Person<T>
{
/// <summary>
/// Gets or sets the last name.
/// </summary>
/// <value>
/// The last name.
/// </value>
public string LastName { get; set; }
}
SA1619 The documentation for type parameter 'T' is missing ... PersonLastName.cs./// <typeparam name="T">The type</typeparam> to the Person class's documentation in PersonLastName.cs.CS1710 XML comment has a duplicate typeparam tag for 'T' ... PersonLastName.cs.Interesting! On a side note...
:bulb: You shouldn't use the <summary> element twice. One of these two files should be using <content> instead of <summary>.
Marked as a :bug:. We should only report SA1619 on a partial class if the documentation comment contains a <summary> element. Files which use <content> are additional documentation of code only and do not need to duplicate the type parameter documentation.
It turns out the problem here was caused by the inclusion of duplicate <summary> elements for the type. Replacement of all but one of these elements will also resolve the CS1619 warning per the following:
Most helpful comment
Interesting! On a side note...
:bulb: You shouldn't use the
<summary>element twice. One of these two files should be using<content>instead of<summary>.Marked as a :bug:. We should only report SA1619 on a partial class if the documentation comment contains a
<summary>element. Files which use<content>are additional documentation of code only and do not need to duplicate the type parameter documentation.