SA1604, SA1615 do not support the <include> tag

[qmfrederik]

Consider the following files:

Class.cs:

// <copyright file="Class1.cs" company="PlaceholderCompany">
// Copyright (c) PlaceholderCompany. All rights reserved.
// </copyright>

namespace ClassLibrary3
{
    using System.Threading.Tasks;

    /// <summary>
    /// Sample class.
    /// </summary>
    public class Class1
    {
        /// <include file='Class1.xml' path='/Class1/Foo/*'/>
        public async Task Foo()
        {
            await Task.Delay(0);
        }
    }
}

Class1.xml:

<?xml version="1.0" encoding="utf-8" ?>
<Class1>
  <Foo>
    <summary>
      Sample method.
    </summary>
    <returns>
      A <see cref="Task"/> representing the asynchronous operation.
    </returns>
  </Foo>
</Class1>

The method Foo is documented and the C# compiler correctly generates the documentation for this method.

However, StyleCop reports:

Warning SA1604  Element documentation must have summary ClassLibrary3   Class1.cs   15
Warning SA1615  Element return value must be documented ClassLibrary3   Class1.cs   

Classic StyleCop did support XML <include> statements

[sharwell]

Well, I had no trouble reproducing this but I'm having a ton of trouble getting unit tests to work. I'm starting to think the AdhocWorkspace we use doesn't support resolving files specified in documentation comments. 😶

[sharwell]

Special thanks to @daveaglick who unblocked my testing on this!

[daveaglick]

👍