Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update SA1642 (ConstructorSummaryDocumentationMustBeginWithStandardText) to handle included documentation #1917

Closed
sharwell opened this issue Dec 4, 2015 · 2 comments
Assignees
Milestone

Comments

@sharwell
Copy link
Member

sharwell commented Dec 4, 2015

The issue described in #1603 applies to SA1642 as well.

@peteroupc
Copy link

This issue appears to be reappearing for me, in that this check seems not to expand included documentation even if that documentation contains the required text.

Here is a class which exhibits this issue.

namespace MyNamespace {
  public class MyClass {
    /// <include file='docs.xml'
    /// path='docs/doc[@name="MyClassCons"]/*'/>
    public MyClass(int x){ }
  }
}

Note that the include file references a file called docs.xml, which is as follows for the purposes of this report:

<docs><doc name="MyClassCons">
<summary>Initializes a new instance of the <see cref='MyClass' /> class.</summary></doc></docs>

@sharwell
Copy link
Member Author

@peteroupc Can you create a new issue for this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants