This project is read-only.

xml include tag

Jun 4, 2010 at 2:56 PM


I have a little problem with the xml include tag. XML-Documentation will generated by VS2010 and then parsed and converted by Sandcastle to Html Help File.

If I write the include tag, according to the msdn documrntation, like

/// <include file='Function.xml' path='/Documentation/Member[@name="Function"]/*' />

the workflow makes everything right, but stylecop generates warning SA1604, SA1611 and SA1615. It seems that stylecop cannot parse the content. If i change the line to

/// <include file='Function.xml' path='/Documentation/Member[@name="Function"]' />

everything is fine with stylecop, but the generated XML-Documentation contains the whole XML-Item Member, not just the Content, therefore Sandcastel cannot find valid documentation tags inside the XML file. The xml-file looks like

<?xml version="1.0" encoding="utf-8" ?>
  <Member name="Function">
    <summary>does really cool things</summary>
    <param name="param1">nice parameter one</param>
    <returns>some interesting results</returns>

Is there any way to fix this? Any help is appreciated.


Jun 4, 2010 at 9:29 PM

Looks like a bug in StyleCop. Please file this on the Issue Tracker tab.